Jeremy White 52ffe995b9 Documentation: describe subject more precisely ...

The discussion of email subject throughout the documentation is
misleading; it indicates that the first line will always become
the subject.  In fact, the subject is generally all lines up until
the first full blank line.

This patch refines that, and makes more use of the concept of a
commit title, with the title being all text up to the first blank line.

Signed-off-by: Jeremy White <jwhite@codeweavers.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

2012-09-13 21:30:21 -07:00

..

howto

correct spelling: an URL -> a URL

2012-03-28 08:47:23 -07:00

pt_BR

…

RelNotes

Further merging in preparation for 1.7.12.1

2012-09-12 14:12:48 -07:00

technical

add 'git credential' plumbing command

2012-06-25 11:55:51 -07:00

.gitattributes

…

.gitignore

…

asciidoc.conf

Merge branch 'jk/docs-docbook-monospace-display' into maint-1.7.11

2012-09-11 11:08:40 -07:00

blame-options.txt

use -h for synopsis and --help for manpage consistently

2011-10-05 10:47:10 -07:00

build-docdep.perl

…

cat-texi.perl

…

cmd-list.perl

…

CodingGuidelines

Documentation/CodingGuidelines: spell out more shell guidelines

2012-08-15 11:00:39 -07:00

config.txt

Merge branch 'pg/maint-1.7.9-am-where-is-patch' into maint

2012-07-30 13:04:39 -07:00

date-formats.txt

…

diff-config.txt

Documentation: spelling fixes

2012-06-19 11:35:19 -07:00

diff-format.txt

…

diff-generate-patch.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

diff-options.txt

Documentation: Fix misspellings

2012-06-22 14:25:04 -07:00

docbook-xsl.css

…

docbook.xsl

…

everyday.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

fetch-options.txt

…

fix-texi.perl

…

git-add.txt

…

git-am.txt

Merge branch 'jb/am-include'

2012-04-20 15:49:16 -07:00

git-annotate.txt

…

git-apply.txt

apply: document --3way option

2012-07-09 14:40:03 -07:00

git-archimport.txt

…

git-archive.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-bisect-lk2009.txt

…

git-bisect.txt

…

git-blame.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-branch.txt

Merge branch 'nd/columns'

2012-05-03 15:13:31 -07:00

git-bundle.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-cat-file.txt

…

git-check-attr.txt

Teach '--cached' option to check-attr

2011-09-22 16:38:22 -07:00

git-check-ref-format.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-checkout-index.txt

…

git-checkout.txt

Merge branch 'jc/maint-doc-checkout-b-always-takes-branch-name' into maint-1.7.11

2012-09-12 13:59:58 -07:00

git-cherry-pick.txt

Merge branch 'cn/cherry-pick-range-docs' into maint

2012-07-11 12:45:34 -07:00

git-cherry.txt

…

git-citool.txt

…

git-clean.txt

Documentation: clarify "git clean -e <pattern>"

2011-08-28 23:47:55 -07:00

git-clone.txt

clone: allow --no-local to turn off local optimizations

2012-05-30 09:51:22 -07:00

git-column.txt

Documentation: spelling fixes

2012-06-19 11:35:19 -07:00

git-commit-tree.txt

Revert "git-commit-tree(1): update synopsis"

2012-07-17 13:11:03 -07:00

git-commit.txt

Documentation: describe subject more precisely

2012-09-13 21:30:21 -07:00

git-config.txt

Sync with 1.7.11.6

2012-09-11 11:23:54 -07:00

git-count-objects.txt

…

git-credential-cache--daemon.txt

command-list: mention git-credential-* helpers

2012-08-08 12:11:54 -07:00

git-credential-cache.txt

command-list: mention git-credential-* helpers

2012-08-08 12:11:54 -07:00

git-credential-store.txt

command-list: mention git-credential-* helpers

2012-08-08 12:11:54 -07:00

git-credential.txt

Documentation: list git-credential in plumbing commands

2012-08-08 09:59:17 -07:00

git-cvsexportcommit.txt

…

git-cvsimport.txt

…

git-cvsserver.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-daemon.txt

Merge branch 'ms/daemon-doc-typo' into maint

2012-08-06 15:39:16 -07:00

git-describe.txt

Documentation: do not mention .git/refs/* directories

2012-08-06 14:04:16 -07:00

git-diff-files.txt

…

git-diff-index.txt

…

git-diff-tree.txt

…

git-diff.txt

…

git-difftool.txt

difftool: print list of valid tools with '--tool-help'

2012-04-23 12:00:42 -07:00

git-fast-export.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-fast-import.txt

Merge branch 'jk/doc-asciidoc-inline-literal'

2012-05-02 13:51:45 -07:00

git-fetch-pack.txt

fetch-pack: new --stdin option to read refs from stdin

2012-04-02 13:47:15 -07:00

git-fetch.txt

…

git-filter-branch.txt

Merge branch 'jc/tag-doc' into maint-1.7.11

2012-08-24 12:05:30 -07:00

git-fmt-merge-msg.txt

Document merge.branchdesc configuration variable

2012-02-23 11:20:15 -08:00

git-for-each-ref.txt

Documentation: describe subject more precisely

2012-09-13 21:30:21 -07:00

git-format-patch.txt

Documentation: describe subject more precisely

2012-09-13 21:30:21 -07:00

git-fsck-objects.txt

…

git-fsck.txt

Merge branch 'jc/tag-doc' into maint-1.7.11

2012-08-24 12:05:30 -07:00

git-gc.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-get-tar-commit-id.txt

…

git-grep.txt

Merge branch 'rs/maint-grep-F' into maint

2012-06-01 13:01:41 -07:00

git-gui.txt

…

git-hash-object.txt

…

git-help.txt

…

git-http-backend.txt

…

git-http-fetch.txt

Mark http-fetch without -a as deprecated

2011-08-23 21:36:20 -07:00

git-http-push.txt

…

git-imap-send.txt

…

git-index-pack.txt

index-pack: support multithreaded delta resolving

2012-05-07 15:48:15 -07:00

git-init-db.txt

…

git-init.txt

…

git-instaweb.txt

Documentation: Link to gitweb(1) and gitweb.conf(5) in other manpages

2011-10-16 11:09:35 -07:00

git-log.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-lost-found.txt

Documentation: do not mention .git/refs/* directories

2012-08-06 14:04:16 -07:00

git-ls-files.txt

…

git-ls-remote.txt

…

git-ls-tree.txt

…

git-mailinfo.txt

Merge branch 'tr/maint-mailinfo'

2012-01-12 23:34:26 -08:00

git-mailsplit.txt

…

git-merge-base.txt

…

git-merge-file.txt

…

git-merge-index.txt

…

git-merge-one-file.txt

…

git-merge-tree.txt

…

git-merge.txt

doc: A few minor copy edits.

2012-08-06 15:34:20 -07:00

git-mergetool--lib.txt

Merge branch 'jn/doc-dashdash' into maint

2011-09-11 21:52:18 -07:00

git-mergetool.txt

mergetool: support --tool-help option like difftool does

2012-07-23 14:42:39 -07:00

git-mktag.txt

…

git-mktree.txt

…

git-mv.txt

mv: honor --verbose flag

2011-12-12 11:52:31 -08:00

git-name-rev.txt

…

git-notes.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-p4.txt

git p4: refactor diffOpts calculation

2012-07-05 23:23:28 -07:00

git-pack-objects.txt

…

git-pack-redundant.txt

…

git-pack-refs.txt

Merge branch 'jc/tag-doc' into maint-1.7.11

2012-08-24 12:05:30 -07:00

git-parse-remote.txt

…

git-patch-id.txt

…

git-peek-remote.txt

…

git-prune-packed.txt

…

git-prune.txt

…

git-pull.txt

man: git pull -r is a short for --rebase

2012-08-17 00:26:52 -07:00

git-push.txt

Merge branch 'jk/doc-asciidoc-inline-literal'

2012-05-02 13:51:45 -07:00

git-quiltimport.txt

…

git-read-tree.txt

Merge branch 'jh/fetch-head-update'

2012-01-06 12:44:01 -08:00

git-rebase.txt

doc: A few minor copy edits.

2012-08-06 15:34:20 -07:00

git-receive-pack.txt

Sync with 1.7.6.2

2011-09-06 11:42:12 -07:00

git-reflog.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-relink.txt

…

git-remote-ext.txt

…

git-remote-fd.txt

…

git-remote-helpers.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-remote-testgit.txt

(short) documentation for the testgit remote helper

2011-09-01 15:52:02 -07:00

git-remote.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-repack.txt

fsck: --no-dangling omits "dangling object" information

2012-02-28 14:55:39 -08:00

git-replace.txt

Documentation: do not mention .git/refs/* directories

2012-08-06 14:04:16 -07:00

git-repo-config.txt

…

git-request-pull.txt

…

git-rerere.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-reset.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-rev-list.txt

…

git-rev-parse.txt

Merge branch 'jc/sha1-name-more'

2012-07-22 12:55:07 -07:00

git-revert.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-rm.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-send-email.txt

send-email: document the --smtp-debug option

2012-02-27 10:29:24 -08:00

git-send-pack.txt

Revert "Merge branch 'cb/maint-quiet-push' into maint"

2011-09-06 11:10:41 -07:00

git-sh-i18n--envsubst.txt

correct a few doubled-word nits in comments and documentation

2012-03-28 11:18:35 -07:00

git-sh-i18n.txt

Merge branch 'jn/doc-dashdash' into maint

2011-09-11 21:52:18 -07:00

git-sh-setup.txt

Merge branch 'tr/doc-sh-setup' into maint

2011-12-28 11:42:51 -08:00

git-shell.txt

…

git-shortlog.txt

Documentation: describe subject more precisely

2012-09-13 21:30:21 -07:00

git-show-branch.txt

…

git-show-index.txt

…

git-show-ref.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-show.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-stage.txt

…

git-stash.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-status.txt

Merge branch 'jk/maint-status-porcelain-z-b' into maint

2012-05-24 17:32:30 -07:00

git-stripspace.txt

Update documentation for stripspace

2011-12-12 16:48:54 -08:00

git-submodule.txt

Make 'git submodule update --force' always check out submodules.

2012-08-24 09:00:43 -07:00

git-svn.txt

git-svn: clarify the referent of dcommit's optional argument

2012-05-17 09:35:18 +00:00

git-symbolic-ref.txt

symbolic-ref --short: abbreviate the output unambiguously

2012-02-27 15:58:36 -08:00

git-tag.txt

Merge branch 'jc/tag-doc' into maint-1.7.11

2012-08-24 12:05:30 -07:00

git-tar-tree.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-tools.txt

…

git-unpack-file.txt

…

git-unpack-objects.txt

…

git-update-index.txt

update-index: upgrade/downgrade on-disk index version

2012-04-04 09:57:50 -07:00

git-update-ref.txt

…

git-update-server-info.txt

…

git-upload-archive.txt

…

git-upload-pack.txt

Merge branch 'js/ref-namespaces'

2011-08-17 17:35:38 -07:00

git-var.txt

ident: report passwd errors with a more friendly message

2012-05-22 09:08:20 -07:00

git-verify-pack.txt

…

git-verify-tag.txt

…

git-web--browse.txt

Merge branch 'jn/doc-dashdash' into maint

2011-09-11 21:52:18 -07:00

git-whatchanged.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

git-write-tree.txt

…

git.txt

Sync with 1.7.11.6

2012-09-11 11:23:54 -07:00

gitattributes.txt

Let core.attributesfile default to $XDG_CONFIG_HOME/git/attributes

2012-06-25 09:06:15 -07:00

gitcli.txt

gitcli: describe abbreviation of long options

2012-08-16 23:16:28 -07:00

gitcore-tutorial.txt

Documentation: describe subject more precisely

2012-09-13 21:30:21 -07:00

gitcredentials.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

gitcvs-migration.txt

…

gitdiffcore.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

gitglossary.txt

…

githooks.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

gitignore.txt

Let core.excludesfile default to $XDG_CONFIG_HOME/git/ignore

2012-06-25 09:06:15 -07:00

gitk.txt

…

gitmodules.txt

document submdule.$name.update=none option for gitmodules

2012-05-11 08:39:33 -07:00

gitnamespaces.txt

Documentation/gitnamespaces.txt: cater to older asciidoc

2011-09-16 09:20:23 -07:00

gitrepository-layout.txt

Documentation: Grammar correction, wording fixes and cleanup

2011-08-23 21:35:47 -07:00

gitrevisions.txt

…

gittutorial-2.txt

Use correct grammar in diffstat summary line

2012-02-03 23:19:42 -08:00

gittutorial.txt

Documentation: describe subject more precisely

2012-09-13 21:30:21 -07:00

gitweb.conf.txt

Documentation: spelling fixes

2012-06-19 11:35:19 -07:00

gitweb.txt

Documentation/gitweb: trivial English fixes

2012-03-23 11:22:04 -07:00

gitworkflows.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

glossary-content.txt

doc: A few minor copy edits.

2012-08-06 15:34:20 -07:00

howto-index.sh

…

i18n.txt

…

install-doc-quick.sh

docs: Update install-doc-quick

2011-11-08 13:37:10 -08:00

install-webdoc.sh

…

mailmap.txt

…

Makefile

check-docs: get documented command list from Makefile

2012-08-08 14:32:17 -07:00

manpage-1.72.xsl

…

manpage-base-url.xsl.in

…

manpage-base.xsl

…

manpage-bold-literal.xsl

…

manpage-normal.xsl

…

manpage-quote-apos.xsl

…

manpage-suppress-sp.xsl

…

merge-config.txt

…

merge-options.txt

merge: backport GIT_MERGE_AUTOEDIT support

2012-03-20 15:39:10 -07:00

merge-strategies.txt

…

pretty-formats.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

pretty-options.txt

…

pull-fetch-param.txt

docs: stop using asciidoc no-inline-literal

2012-04-26 13:19:06 -07:00

rev-list-options.txt

Merge branch 'jc/maint-rev-list-topo-doc' into maint-1.7.11

2012-08-24 12:05:40 -07:00

revisions.txt

specifying ranges: we did not mean to make ".." an empty set

2012-08-23 14:37:49 -07:00

sequencer.txt

revert: introduce --abort to cancel a failed cherry-pick

2011-11-22 18:16:59 -08:00

SubmittingPatches

SubmittingPathces: remove Cogito reference

2011-09-11 20:53:00 -07:00

urls-remotes.txt

…

urls.txt

…

user-manual.conf

docs: monospace listings in docbook output

2012-08-07 14:30:52 -07:00

user-manual.txt

Documentation: describe subject more precisely

2012-09-13 21:30:21 -07:00