brian m. carlson 813f6025a5 docs: expand on possible and recommended user config options ...

In the section on setting author and committer information, we omit the
author.* and committer.* variables, so mention them for completeness.
In addition, guide users to the typical case: simply setting user.name
and user.email, which are recommended if one does not need complex
configuration.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

2020-01-22 12:27:08 -08:00

..

config

doc: move author and committer information to git-commit(1)

2020-01-22 12:27:08 -08:00

howto

Documentation: fix a bunch of typos, both old and new

2019-11-07 13:42:00 +09:00

RelNotes

Revert "Merge branch 'ra/rebase-i-more-options'"

2020-01-12 13:25:18 -08:00

technical

Merge branch 'jb/doc-multi-pack-idx-fix'

2020-01-08 12:44:12 -08:00

.gitattributes

…

.gitignore

Merge branch 'js/misc-doc-fixes'

2019-05-09 00:37:27 +09:00

asciidoc.conf

Doc/Makefile: give mansource/-version/-manual attributes

2019-09-16 12:27:34 -07:00

asciidoctor-extensions.rb

Merge branch 'ma/user-manual-markup-update'

2019-10-06 12:25:16 +09:00

blame-options.txt

blame: add config options for the output of ignored or unblamable lines

2019-05-16 11:36:23 +09:00

build-docdep.perl

…

cat-texi.perl

Documentation: remove unneeded argument in cat-texi.perl

2017-01-23 10:56:47 -08:00

cmd-list.perl

command-list: prepare machinery for upcoming "common groups" section

2015-05-21 13:03:37 -07:00

CodingGuidelines

Documentation: fix a bunch of typos, both old and new

2019-11-07 13:42:00 +09:00

config.txt

Documentation: fix a bunch of typos, both old and new

2019-11-07 13:42:00 +09:00

date-formats.txt

Merge branch 'lr/doc-fix-cet' into maint

2017-01-17 15:19:08 -08:00

diff-format.txt

doc: indent multi-line items in list

2019-12-13 12:18:07 -08:00

diff-generate-patch.txt

diff, log doc: small grammer, format, and language fixes

2019-09-17 12:14:06 -07:00

diff-options.txt

Merge branch 'nd/diff-parseopt-3'

2019-04-16 19:28:03 +09:00

doc-diff

doc-diff: replace --cut-header-footer with --cut-footer

2019-09-16 12:27:38 -07:00

docbook-xsl.css

…

docbook.xsl

…

everyday.txto

Documentation: fix linkgit references

2016-05-09 15:44:14 -07:00

fetch-options.txt

fetch: add the command-line option --write-commit-graph

2019-11-06 10:59:36 +09:00

fix-texi.perl

…

git-add.txt

add: support the --pathspec-from-file option

2019-12-04 10:10:37 -08:00

git-am.txt

Merge branch 'pm/am-in-body-header-doc-update'

2020-01-08 12:44:12 -08:00

git-annotate.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-apply.txt

Merge branch 'nd/diff-apply-ita'

2018-06-25 13:22:36 -07:00

git-archimport.txt

git-archimport.1: specify what kind of Arch we're talking about

2018-09-21 09:28:58 -07:00

git-archive.txt

…

git-bisect-lk2009.txt

Merge branch 'dl/lore-is-the-archive'

2019-12-06 15:09:24 -08:00

git-bisect.txt

Documentation/git-bisect.txt: add --no-ff to merge command

2019-10-29 11:53:56 +09:00

git-blame.txt

blame: add the ability to ignore commits and their changes

2019-05-16 11:36:23 +09:00

git-branch.txt

Merge branch 'po/doc-branch' into maint

2019-07-29 12:38:16 -07:00

git-bundle.txt

Merge branch 'po/bundle-doc-clonable'

2019-12-10 13:11:41 -08:00

git-cat-file.txt

Merge branch 'dt/cat-file-batch-ambiguous'

2019-02-06 22:05:21 -08:00

git-check-attr.txt

Documentation: fix a bunch of typos, both old and new

2019-11-07 13:42:00 +09:00

git-check-ignore.txt

Documentation: fix a bunch of typos, both old and new

2019-11-07 13:42:00 +09:00

git-check-mailmap.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-check-ref-format.txt

doc: promote "git switch"

2019-04-02 13:57:00 +09:00

git-checkout-index.txt

…

git-checkout.txt

checkout, restore: support the --pathspec-from-file option

2019-12-04 10:10:37 -08:00

git-cherry-pick.txt

cherry-pick/revert: add --skip option

2019-07-02 12:08:08 -07:00

git-cherry.txt

…

git-citool.txt

…

git-clean.txt

Merge branch 'en/clean-nested-with-ignored'

2019-10-11 14:24:46 +09:00

git-clone.txt

Merge branch 'ja/doc-markup-cleanup'

2019-12-25 11:22:00 -08:00

git-column.txt

git-column.txt: fix section header

2018-12-26 15:29:30 -08:00

git-commit-graph.txt

test-tool: use 'read-graph' helper

2019-11-13 11:14:16 +09:00

git-commit-tree.txt

doc: move author and committer information to git-commit(1)

2020-01-22 12:27:08 -08:00

git-commit.txt

docs: expand on possible and recommended user config options

2020-01-22 12:27:08 -08:00

git-config.txt

Documentation: wrap config listings in "----"

2019-09-09 11:05:51 -07:00

git-count-objects.txt

count-objects: report alternates via verbose mode

2016-10-10 13:52:37 -07:00

git-credential-cache--daemon.txt

…

git-credential-cache.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-credential-store.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-credential.txt

credential: move doc to credential.h

2019-11-18 15:21:29 +09:00

git-cvsexportcommit.txt

…

git-cvsimport.txt

Merge branch 'jk/doc-cvs-update' into maint

2016-10-03 13:22:25 -07:00

git-cvsserver.txt

Documentation: fix a bunch of typos, both old and new

2019-11-07 13:42:00 +09:00

git-daemon.txt

doc: format pathnames and URLs as monospace.

2019-03-13 11:14:22 +09:00

git-describe.txt

describe doc: remove '7-char' abbreviation reference

2019-04-08 17:24:51 +09:00

git-diff-files.txt

…

git-diff-index.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-diff-tree.txt

Documentation/git-diff-tree.txt: fix formatting

2019-04-01 15:17:47 +09:00

git-diff.txt

git-diff.txt: document return code of --no-index

2019-11-02 13:16:41 +09:00

git-difftool.txt

difftool: fallback on merge.guitool

2019-05-13 23:11:59 +09:00

git-fast-export.txt

Documentation: fix a bunch of typos, both old and new

2019-11-07 13:42:00 +09:00

git-fast-import.txt

Sync with 2.23.1

2019-12-06 16:31:39 +01:00

git-fetch-pack.txt

Documentation: fix several one-character-off spelling errors

2018-04-09 14:15:02 +09:00

git-fetch.txt

doc: typo: s/can not/cannot/ and s/is does/does/

2019-08-05 10:05:24 -07:00

git-filter-branch.txt

Merge branch 'ja/doc-markup-cleanup'

2019-12-25 11:22:00 -08:00

git-fmt-merge-msg.txt

config.txt: move fmt-merge-msg-config.txt to config/

2018-10-29 10:17:01 +09:00

git-for-each-ref.txt

ref-filter: add worktreepath atom

2019-05-07 13:45:53 +09:00

git-format-patch.txt

format-patch: teach --no-base

2019-12-05 06:06:18 -08:00

git-fsck-objects.txt

…

git-fsck.txt

Documentation/git-fsck.txt: include fsck.* config variables

2019-07-29 10:41:18 -07:00

git-gc.txt

Recommend git-filter-repo instead of git-filter-branch

2019-09-05 13:01:48 -07:00

git-get-tar-commit-id.txt

usage: do not insist that standard input must come from a file

2015-10-16 15:27:52 -07:00

git-grep.txt

grep: make the behavior for NUL-byte in patterns sane

2019-07-01 14:33:14 -07:00

git-gui.txt

Documentation: update the location of the git-gui repo

2019-10-06 09:45:02 +09:00

git-hash-object.txt

hash-object doc: stop mentioning git-cvsimport

2019-05-28 10:47:42 -07:00

git-help.txt

doc: format pathnames and URLs as monospace.

2019-03-13 11:14:22 +09:00

git-http-backend.txt

Documentation: turn middle-of-line tabs into spaces

2019-03-07 09:25:32 +09:00

git-http-fetch.txt

http-fetch: make -a standard behaviour

2018-04-24 10:55:02 +09:00

git-http-push.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-imap-send.txt

git-imap-send.txt: move imap.* to a separate file

2018-10-29 10:17:02 +09:00

git-index-pack.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-init-db.txt

…

git-init.txt

Merge branch 'km/init-doc-typofix'

2019-02-06 22:05:21 -08:00

git-instaweb.txt

git-instaweb: add Python builtin http.server support

2019-01-28 10:57:44 -08:00

git-interpret-trailers.txt

interpret-trailers.txt: start the desc line with a capital letter

2019-04-01 15:49:47 +09:00

git-log.txt

Merge branch 'pb/clarify-line-log-doc'

2020-01-06 14:17:50 -08:00

git-ls-files.txt

doc/ls-files: put nested list for "-t" option into block

2019-04-23 10:25:04 +09:00

git-ls-remote.txt

git-ls-remote.txt: wrap shell listing in "----"

2019-09-09 11:05:52 -07:00

git-ls-tree.txt

doc: format pathnames and URLs as monospace.

2019-03-13 11:14:22 +09:00

git-mailinfo.txt

Merge branch 'va/mailinfo-doc-typofix' into maint

2016-05-26 13:17:14 -07:00

git-mailsplit.txt

mailsplit: support unescaping mboxrd messages

2016-06-06 11:14:43 -07:00

git-merge-base.txt

git-merge-base.txt: render indentations correctly under Asciidoctor

2019-09-09 11:05:51 -07:00

git-merge-file.txt

merge-file: clamp exit code to maximum 127

2015-10-29 12:10:23 -07:00

git-merge-index.txt

git-merge-index.txt: wrap shell listing in "----"

2019-09-09 11:05:52 -07:00

git-merge-one-file.txt

…

git-merge-tree.txt

…

git-merge.txt

merge: do no-verify like commit

2019-08-07 12:37:33 -07:00

git-mergetool--lib.txt

mergetool: use get_merge_tool function

2019-05-13 23:11:59 +09:00

git-mergetool.txt

mergetool: fallback to tool when guitool unavailable

2019-05-13 23:11:59 +09:00

git-mktag.txt

usage: do not insist that standard input must come from a file

2015-10-16 15:27:52 -07:00

git-mktree.txt

Documentation: normalize spelling of 'normalised'

2018-04-09 14:15:07 +09:00

git-multi-pack-index.txt

multi-pack-index: add [--[no-]progress] option.

2019-10-23 12:05:06 +09:00

git-mv.txt

doc: typeset short command-line options as literal

2016-06-28 08:20:52 -07:00

git-name-rev.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-notes.txt

notes: fix minimum number of parameters to "copy" subcommand

2019-10-18 09:43:10 +09:00

git-p4.txt

doc: tidy asciidoc style

2019-01-23 11:37:29 -08:00

git-pack-objects.txt

doc: fix repeated words

2019-08-11 17:40:07 -07:00

git-pack-redundant.txt

…

git-pack-refs.txt

…

git-parse-remote.txt

…

git-patch-id.txt

doc: remove unsupported parameter from patch-id

2017-07-28 14:41:32 -07:00

git-prune-packed.txt

…

git-prune.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-pull.txt

doc: typo: s/can not/cannot/ and s/is does/does/

2019-08-05 10:05:24 -07:00

git-push.txt

doc: fix repeated words

2019-08-11 17:40:07 -07:00

git-quiltimport.txt

git-quiltimport: add --keep-non-patch option

2019-01-07 15:29:34 -08:00

git-range-diff.txt

Merge branch 'dl/range-diff-with-notes'

2019-12-05 12:52:44 -08:00

git-read-tree.txt

sparse-checkout: create builtin with 'list' subcommand

2019-11-22 16:11:43 +09:00

git-rebase.txt

Revert "Merge branch 'ra/rebase-i-more-options'"

2020-01-12 13:25:18 -08:00

git-receive-pack.txt

git-receive-pack.txt: wrap shell [script] listing in "----"

2019-09-09 11:05:52 -07:00

git-reflog.txt

reflog expire: cover reflog from all worktrees

2018-10-22 13:32:54 +09:00

git-remote-ext.txt

Merge branch 'js/check-docs-exe'

2019-04-22 11:14:46 +09:00

git-remote-fd.txt

docs: move gitremote-helpers into section 7

2019-04-01 14:00:53 +09:00

git-remote-helpers.txto

docs: move gitremote-helpers into section 7

2019-04-01 14:00:53 +09:00

git-remote.txt

doc: promote "git switch"

2019-04-02 13:57:00 +09:00

git-repack.txt

doc: fix repeated words

2019-08-11 17:40:07 -07:00

git-replace.txt

Recommend git-filter-repo instead of git-filter-branch

2019-09-05 13:01:48 -07:00

git-request-pull.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-rerere.txt

Merge branch 'nd/switch-and-restore'

2019-07-09 15:25:44 -07:00

git-reset.txt

reset: support the --pathspec-from-file option

2019-11-20 13:01:53 +09:00

git-restore.txt

checkout, restore: support the --pathspec-from-file option

2019-12-04 10:10:37 -08:00

git-rev-list.txt

git-rev-list.txt: prune options in synopsis

2019-10-06 09:45:19 +09:00

git-rev-parse.txt

rev-parse: make --show-toplevel without a worktree an error

2019-11-20 10:19:58 +09:00

git-revert.txt

Merge branch 'ra/cherry-pick-revert-skip'

2019-07-19 11:30:21 -07:00

git-rm.txt

treewide: correct several "up-to-date" to "up to date"

2017-08-23 12:17:22 -07:00

git-send-email.txt

Documentation: wrap config listings in "----"

2019-09-09 11:05:51 -07:00

git-send-pack.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-sh-i18n--envsubst.txt

…

git-sh-i18n.txt

…

git-sh-setup.txt

doc: more consistency in environment variables format

2016-06-08 12:04:37 -07:00

git-shell.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-shortlog.txt

git-shortlog.txt: include commit limiting options

2019-11-10 15:13:23 +09:00

git-show-branch.txt

Documentation/git-show-branch: avoid literal {apostrophe}

2019-04-10 12:05:03 +09:00

git-show-index.txt

show-index: update documentation for index v2

2018-05-29 00:28:22 +09:00

git-show-ref.txt

git-show-ref.txt: fix order of flags

2019-01-10 10:29:05 -08:00

git-show.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-sparse-checkout.txt

Merge branch 'ds/sparse-cone'

2020-01-06 14:17:51 -08:00

git-stage.txt

…

git-stash.txt

doc(stash): clarify the description of save

2019-10-11 14:28:04 +09:00

git-status.txt

Documentation: wrap blocks with "--"

2019-09-09 11:05:51 -07:00

git-stripspace.txt

usage: do not insist that standard input must come from a file

2015-10-16 15:27:52 -07:00

git-submodule.txt

Merge branch 'tm/doc-submodule-absorb-fix'

2020-01-08 12:44:12 -08:00

git-svn.txt

git svn: stop using rebase --preserve-merges

2019-11-23 09:49:23 +09:00

git-switch.txt

Declare both git-switch and git-restore experimental

2019-05-07 13:04:48 +09:00

git-symbolic-ref.txt

…

git-tag.txt

Documentation: fix a bunch of typos, both old and new

2019-11-07 13:42:00 +09:00

git-tools.txt

doc: replace or.cz gitwiki link with git.wiki.kernel.org

2017-04-20 22:05:37 -07:00

git-unpack-file.txt

…

git-unpack-objects.txt

unpack-objects: add --max-input-size=<size> option

2016-08-24 12:31:05 -07:00

git-update-index.txt

Merge branch 'en/doc-typofix'

2019-12-01 09:04:35 -08:00

git-update-ref.txt

Merge branch 'ah/doc-updates' into maint

2018-11-21 22:58:07 +09:00

git-update-server-info.txt

update-server-info: avoid needless overwrites

2019-05-15 14:07:37 +09:00

git-upload-archive.txt

Documentation: match underline with the text

2015-10-22 10:16:12 -07:00

git-upload-pack.txt

doc: tidy asciidoc style

2019-01-23 11:37:29 -08:00

git-var.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-verify-commit.txt

Merge branch 'dn/gpg-doc' into maint

2016-07-06 13:06:36 -07:00

git-verify-pack.txt

…

git-verify-tag.txt

builtin/verify-tag: add --format to verify-tag

2017-01-17 16:10:22 -08:00

git-web--browse.txt

doc: format pathnames and URLs as monospace.

2019-03-13 11:14:22 +09:00

git-whatchanged.txt

…

git-worktree.txt

doc: fix typos in man pages

2019-03-18 14:45:21 +09:00

git-write-tree.txt

…

git.txt

doc: move author and committer information to git-commit(1)

2020-01-22 12:27:08 -08:00

gitattributes.txt

Merge branch 'ln/userdiff-elixir'

2019-12-01 09:04:36 -08:00

gitcli.txt

Merge branch 'dl/lore-is-the-archive'

2019-12-06 15:09:24 -08:00

gitcore-tutorial.txt

doc: promote "git switch"

2019-04-02 13:57:00 +09:00

gitcredentials.txt

credential: move doc to credential.h

2019-11-18 15:21:29 +09:00

gitcvs-migration.txt

Merge branch 'sb/doc-unify-bottom'

2017-02-15 12:54:20 -08:00

gitdiffcore.txt

log -G: ignore binary files

2018-12-26 14:59:37 -08:00

giteveryday.txt

doc: promote "git restore"

2019-05-07 13:04:48 +09:00

gitglossary.txt

Documentation: unify bottom "part of git suite" lines

2017-02-09 15:14:01 -08:00

githooks.txt

Merge branch 'en/filter-branch-deprecation'

2019-09-30 13:19:29 +09:00

gitignore.txt

Merge branch 'an/ignore-doc-update' into maint

2019-07-25 14:27:13 -07:00

gitk.txt

doc: log, gitk: line-log arguments must exist in starting revision

2019-12-26 11:00:15 -08:00

gitmodules.txt

Merge branch 'pb/submodule-doc-xref'

2019-12-25 11:21:59 -08:00

gitnamespaces.txt

doc: mention transfer data leaks in more places

2016-11-14 11:23:07 -08:00

gitremote-helpers.txt

Merge branch 'bc/smart-http-atomic-push'

2019-10-23 14:43:11 +09:00

gitrepository-layout.txt

Merge branch 'sg/dir-trie-fixes'

2019-11-10 18:02:14 +09:00

gitrevisions.txt

push doc: correct lies about how push refspecs work

2018-08-31 14:04:06 -07:00

gitsubmodules.txt

help: add gitsubmodules to the list of guides

2019-10-29 12:41:05 +09:00

gittutorial-2.txt

doc: promote "git restore"

2019-05-07 13:04:48 +09:00

gittutorial.txt

doc: promote "git restore"

2019-05-07 13:04:48 +09:00

gitweb.conf.txt

gitweb.conf.txt: switch pluses to backticks to help Asciidoctor

2019-09-09 11:05:52 -07:00

gitweb.txt

doc: don't use git.kernel.org as example gitweb URL

2019-06-24 12:37:21 -07:00

gitworkflows.txt

doc: promote "git switch"

2019-04-02 13:57:00 +09:00

glossary-content.txt

doc: typo: s/can not/cannot/ and s/is does/does/

2019-08-05 10:05:24 -07:00

howto-index.sh

…

i18n.txt

doc: camelCase the i18n config variables to improve readability

2017-07-17 15:11:26 -07:00

install-doc-quick.sh

install-doc-quick: allow specifying what ref to install

2017-12-12 16:49:40 -08:00

install-webdoc.sh

…

line-range-format.txt

…

lint-gitlink.perl

ci: validate "linkgit:" in documentation

2016-05-10 11:15:04 -07:00

mailmap.txt

…

Makefile

Merge branch 'es/walken-tutorial'

2019-11-10 18:02:11 +09:00

manpage-1.72.xsl

…

manpage-base-url.xsl.in

…

manpage-base.xsl

…

manpage-bold-literal.xsl

manpage-bold-literal.xsl: match for namespaced "d:literal" in template

2019-11-02 14:46:42 +09:00

manpage-normal.xsl

…

manpage-quote-apos.xsl

…

manpage-suppress-sp.xsl

…

manpage.xsl

Documentation: fix build with Asciidoctor 2

2019-09-16 12:20:39 -07:00

merge-options.txt

Documentation: fix a bunch of typos, both old and new

2019-11-07 13:42:00 +09:00

merge-strategies.txt

merge-strategies: fix typo "reflected to" to "reflected in"

2019-11-11 11:04:46 +09:00

MyFirstContribution.txt

Merge branch 'jk/lore-is-the-archive'

2019-12-06 15:09:23 -08:00

MyFirstObjectWalk.txt

cache: move doc to cache.h

2019-11-18 15:21:29 +09:00

pretty-formats.txt

Merge branch 'dl/pretty-reference'

2019-12-10 13:11:43 -08:00

pretty-options.txt

Merge branch 'dl/pretty-reference'

2019-12-10 13:11:43 -08:00

pull-fetch-param.txt

fetch doc: correct grammar in --force docs

2018-09-20 09:40:03 -07:00

rev-list-options.txt

Merge branch 'dl/pretty-reference'

2019-12-10 13:11:43 -08:00

revisions.txt

Merge branch 'nd/switch-and-restore'

2019-07-09 15:25:44 -07:00

sequencer.txt

cherry-pick/revert: add --skip option

2019-07-02 12:08:08 -07:00

SubmittingPatches

Merge branch 'dl/pretty-reference'

2019-12-10 13:11:43 -08:00

texi.xsl

Documentation: add XSLT to fix DocBook for Texinfo

2017-01-23 10:56:53 -08:00

trace2-target-values.txt

docs: mention trace2 target-dir mode in git-config

2019-10-04 09:26:42 +09:00

transfer-data-leaks.txt

doc: mention transfer data leaks in more places

2016-11-14 11:23:07 -08:00

urls-remotes.txt

Documentation: match underline with the text

2015-10-22 10:16:12 -07:00

urls.txt

Doc: Bundle file usage

2019-10-21 12:02:39 +09:00

user-manual.conf

…

user-manual.txt

Merge branch 'dl/lore-is-the-archive'

2019-12-06 15:09:24 -08:00