Jeff King 5e83cca0b8 git-status.txt: mention --no-optional-locks ...

If you come to the documentation thinking "I do not want Git
to take any locks for my background processes", then you may
easily run across "--no-optional-locks" in git.txt.

But it's quite reasonable to hit a specific instance of the
problem: you have "git status" running in the background,
and you notice that it causes lock contention with other
processes. So you look in git-status.txt to see if there is
a way to disable it, but there's no mention of the flag.

Let's add a short note mentioning that status does indeed
touch the index (and why), with a pointer to the global
option. That can point users in the right direction and help
them make a more informed decision about what they're
disabling.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

2017-11-27 15:09:56 +09:00

..

howto

doc: use https links to avoid http redirect

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

RelNotes

Git 2.14.2

2017-09-22 14:51:37 +09:00

technical

Merge branch 'ma/pager-per-subcommand-action' into maint

2017-09-10 17:02:48 +09:00

.gitattributes

…

.gitignore

doc: generate a list of valid merge tools

2013-02-02 21:46:52 -08:00

asciidoc.conf

Documentation: avoid poor-man's small caps GIT

2013-02-01 13:53:25 -08:00

asciidoctor-extensions.rb

Documentation: implement linkgit macro for Asciidoctor

2017-01-31 12:18:18 -08:00

blame-options.txt

Merge branch 'bc/blame-doc-fix'

2017-02-24 10:48:08 -08: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

Merge branch 'ab/c-translators-comment-style' into maint

2017-06-05 09:03:10 +09:00

config.txt

Merge branch 'jk/doc-the-this' into maint

2017-09-10 17:03:07 +09:00

date-formats.txt

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

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

diff-config.txt

doc: add missing values "none" and "default" for diff.wsErrorHighlight

2017-07-25 14:30:49 -07:00

diff-format.txt

Documentation: improve description for core.quotePath

2017-03-02 11:40:51 -08:00

diff-generate-patch.txt

Documentation: improve description for core.quotePath

2017-03-02 11:40:51 -08:00

diff-heuristic-options.txt

diff: retire "compaction" heuristics

2016-12-23 12:32:22 -08:00

diff-options.txt

Merge branch 'ah/doc-wserrorhighlight' into maint

2017-08-23 14:33:51 -07:00

docbook-xsl.css

…

docbook.xsl

…

everyday.txto

Documentation: fix linkgit references

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

fetch-options.txt

Merge branch 'nd/shallow-deepen'

2016-10-10 14:03:50 -07:00

fix-texi.perl

…

fmt-merge-msg-config.txt

Documentation: include 'merge.branchdesc' for merge and config as well

2015-05-28 12:38:46 -07:00

git-add.txt

add: warn when adding an embedded repository

2017-06-15 09:10:44 -07:00

git-am.txt

Merge branch 'mm/doc-tt'

2016-07-13 11:24:14 -07:00

git-annotate.txt

blame: honor the diff heuristic options and config

2016-09-19 10:25:11 -07:00

git-apply.txt

Documentation: improve description for core.quotePath

2017-03-02 11:40:51 -08:00

git-archimport.txt

docs/archimport: quote sourcecontrol.net reference

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

git-archive.txt

docs: clarify remote restrictions for git-upload-archive

2014-02-28 09:55:35 -08:00

git-bisect-lk2009.txt

doc: replace more gmane links

2017-05-09 21:13:13 -07:00

git-bisect.txt

git-bisect.txt: add missing word

2017-04-01 11:35:45 -07:00

git-blame.txt

Merge branch 'jc/blame-reverse'

2016-10-10 14:03:51 -07:00

git-branch.txt

Documentation: use proper wording for ref format strings

2017-08-18 09:54:09 -07:00

git-bundle.txt

transport: drop support for git-over-rsync

2016-02-01 13:07:41 -08:00

git-cat-file.txt

cat-file: support --textconv/--filters in batch mode

2016-09-11 14:48:15 -07:00

git-check-attr.txt

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

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

git-check-ignore.txt

Documentation: fix linkgit references

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

git-check-mailmap.txt

builtin: add git-check-mailmap command

2013-07-13 10:19:37 -07:00

git-check-ref-format.txt

git-check-ref-format: clarify documentation for --normalize

2017-02-21 13:02:42 -08:00

git-checkout-index.txt

…

git-checkout.txt

builtin/checkout: add --recurse-submodules switch

2017-03-16 14:07:16 -07:00

git-cherry-pick.txt

Merge branch 'mm/doc-tt' into maint

2016-07-28 11:25:54 -07:00

git-cherry.txt

Documentation: revamp git-cherry(1)

2013-11-27 12:16:49 -08:00

git-citool.txt

…

git-clean.txt

doc: typeset short command-line options as literal

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

git-clone.txt

clone: add a --no-tags option to clone without tags

2017-05-01 11:09:44 +09:00

git-column.txt

doc: remote author/documentation sections from more pages

2014-01-27 08:34:34 -08:00

git-commit-tree.txt

Merge branch 'mm/doc-tt' into maint

2016-07-28 11:25:54 -07:00

git-commit.txt

doc: reformat the paragraph containing the 'cut-line'

2017-07-18 15:04:49 -07:00

git-config.txt

Merge branch 'dg/document-git-c-in-git-config-doc' into maint

2016-09-08 21:35:56 -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

credential-cache: close stderr in daemon process

2014-09-16 11:11:58 -07:00

git-credential-cache.txt

credential-cache: use XDG_CACHE_HOME for socket

2017-03-17 11:19:40 -07:00

git-credential-store.txt

doc: typeset long command-line options as literal

2016-06-28 08:36:45 -07:00

git-credential.txt

Documentation: make AsciiDoc links always point to HTML files

2013-09-06 14:49:06 -07:00

git-cvsexportcommit.txt

Documentation: the name of the system is 'Git', not 'git'

2013-02-01 13:53:33 -08:00

git-cvsimport.txt

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

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

git-cvsserver.txt

doc: typeset HEAD and variants as literal

2016-06-28 08:36:45 -07:00

git-daemon.txt

doc: typeset HEAD and variants as literal

2016-06-28 08:36:45 -07:00

git-describe.txt

builtin/describe: introduce --broken flag

2017-03-22 10:13:41 -07:00

git-diff-files.txt

…

git-diff-index.txt

doc: typeset long command-line options as literal

2016-06-28 08:36:45 -07:00

git-diff-tree.txt

doc: typeset long command-line options as literal

2016-06-28 08:36:45 -07:00

git-diff.txt

diff-files: document --ours etc.

2017-04-13 16:15:25 -07:00

git-difftool.txt

Document the --no-gui option in difftool

2017-02-08 13:30:28 -08:00

git-fast-export.txt

doc: convert \--option to --option

2015-05-12 22:14:46 -07:00

git-fast-import.txt

fast-import: increase the default pack depth to 50

2017-06-12 09:50:33 -07:00

git-fetch-pack.txt

upload-pack: optionally allow fetching any sha1

2016-11-18 13:06:14 -08:00

git-fetch.txt

Merge branch 'mm/push-social-engineering-attack-doc' into maint

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

git-filter-branch.txt

filter-branch: add --setup step

2017-06-12 09:44:54 -07:00

git-fmt-merge-msg.txt

Documentation/fmt-merge-msg: fix markup in example

2016-10-28 05:51:51 -07:00

git-for-each-ref.txt

Merge branch 'mg/format-ref-doc-fix' into maint

2017-09-10 17:03:06 +09:00

git-format-patch.txt

Merge branch 'xy/format-patch-base'

2017-04-23 22:07:55 -07:00

git-fsck-objects.txt

…

git-fsck.txt

fsck: optionally show more helpful info for broken links

2016-07-18 15:15:59 -07:00

git-gc.txt

docs/git-gc: fix default value for --aggressiveDepth

2017-02-24 09:59:12 -08: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 & rev-list doc: stop promising libpcre for --perl-regexp

2017-05-21 08:25:37 +09:00

git-gui.txt

doc: git-gui browser does not default to HEAD

2017-01-13 12:23:28 -08:00

git-hash-object.txt

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

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

git-help.txt

doc: typeset long command-line options as literal

2016-06-28 08:36:45 -07:00

git-http-backend.txt

doc: more consistency in environment variables format

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

git-http-fetch.txt

Documentation: the name of the system is 'Git', not 'git'

2013-02-01 13:53:33 -08:00

git-http-push.txt

doc: typeset long command-line options as literal

2016-06-28 08:36:45 -07:00

git-imap-send.txt

imap-send: use cURL automatically when NO_OPENSSL defined

2015-03-10 15:19:05 -07:00

git-index-pack.txt

index-pack: add --max-input-size=<size> option

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

git-init-db.txt

Documentation: the name of the system is 'Git', not 'git'

2013-02-01 13:53:33 -08:00

git-init.txt

init: document dotfiles exclusion on template copy

2017-02-17 15:57:21 -08:00

git-instaweb.txt

doc: change configuration variables format

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

git-interpret-trailers.txt

Documentation: fix reference to ifExists for interpret-trailers

2017-05-23 14:18:26 +09:00

git-log.txt

Merge branch 'mj/log-show-signature-conf'

2016-07-11 10:31:08 -07:00

git-ls-files.txt

Merge branch 'mm/ls-files-s-doc'

2017-04-16 23:29:30 -07:00

git-ls-remote.txt

ls-remote: add support for showing symrefs

2016-01-19 10:07:56 -08:00

git-ls-tree.txt

Documentation: improve description for core.quotePath

2017-03-02 11:40:51 -08: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

doc: fix merge-base ASCII art tab spacing

2016-10-21 09:46:48 -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

The name of the hash function is "SHA-1", not "SHA1"

2013-04-15 11:08:37 -07:00

git-merge-one-file.txt

…

git-merge-tree.txt

use 'tree-ish' instead of 'treeish'

2013-09-04 15:02:56 -07:00

git-merge.txt

Documentation/git-merge: explain --continue

2017-08-21 17:12:44 -07:00

git-mergetool--lib.txt

Documentation: the name of the system is 'Git', not 'git'

2013-02-01 13:53:33 -08:00

git-mergetool.txt

mergetool: honor -O<orderfile>

2016-10-11 10:04:31 -07: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

doc: typeset short command-line options as literal

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

git-mv.txt

doc: typeset short command-line options as literal

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

git-name-rev.txt

name-rev: add support to exclude refs by pattern match

2017-01-23 18:33:17 -08:00

git-notes.txt

doc: typeset short command-line options as literal

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

git-p4.txt

Merge branch 'ls/p4-retry-thrice'

2017-01-18 15:12:12 -08:00

git-pack-objects.txt

Doc: clarify that pack-objects makes packs, plural

2017-08-23 10:39:41 -07:00

git-pack-redundant.txt

…

git-pack-refs.txt

Documentation: remove --prune from pack-refs examples

2013-07-18 16:23:46 -07:00

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

Documentation: adjust document title underlining

2014-10-13 13:35:18 -07:00

git-prune.txt

worktree: new place for "git prune --worktrees"

2015-06-29 08:48:44 -07:00

git-pull.txt

Merge branch 'sb/pull-rebase-submodule'

2017-07-13 16:14:54 -07:00

git-push.txt

push: document & test --force-with-lease with multiple remotes

2017-04-19 18:53:06 -07:00

git-quiltimport.txt

doc: more consistency in environment variables format

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

git-read-tree.txt

Merge branch 'ja/do-not-ask-needless-questions' into maint

2017-06-04 10:20:59 +09:00

git-rebase.txt

Merge branch 'ks/fix-rebase-doc-picture' into maint

2017-07-21 15:03:39 -07:00

git-receive-pack.txt

refs: reject ref updates while GIT_QUARANTINE_PATH is set

2017-04-16 18:19:18 -07:00

git-reflog.txt

git-reflog: add exists command

2015-07-21 14:08:14 -07:00

git-remote-ext.txt

doc: add some crossrefs between manual pages

2014-11-11 14:47:04 -08:00

git-remote-fd.txt

Spelling fixes

2016-08-11 14:35:42 -07:00

git-remote-helpers.txto

Rename {git- => git}remote-helpers.txt

2013-02-01 14:12:34 -08:00

git-remote-testgit.txt

Merge branch 'jk/remote-helpers-doc'

2013-02-07 14:41:45 -08:00

git-remote.txt

doc: typeset long command-line options as literal

2016-06-28 08:36:45 -07:00

git-repack.txt

repack: accept --threads=<n> and pass it down to pack-objects

2017-04-27 08:09:25 +09:00

git-replace.txt

doc: change environment variables format

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

git-request-pull.txt

doc: show usage of branch description

2015-09-14 12:50:33 -07:00

git-rerere.txt

*config.txt: stick to camelCase naming convention

2015-03-13 22:13:46 -07:00

git-reset.txt

Spelling fixes

2017-06-27 10:35:49 -07:00

git-rev-list.txt

Merge branch 'jk/date-local'

2015-10-05 12:30:13 -07:00

git-rev-parse.txt

doc: rewrite description for rev-parse --short

2017-06-01 10:37:42 +09:00

git-revert.txt

doc: typeset long command-line options as literal

2016-06-28 08:36:45 -07:00

git-rm.txt

Merge branch 'sb/submodule-doc'

2017-07-12 15:18:21 -07:00

git-send-email.txt

Merge branch 'xz/send-email-batch-size'

2017-07-06 18:14:46 -07:00

git-send-pack.txt

remote-curl: allow push options

2017-03-22 15:41:21 -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

…

git-sh-setup.txt

doc: more consistency in environment variables format

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

git-shell.txt

shell: drop git-cvsserver support by default

2017-09-12 11:05:58 +09:00

git-shortlog.txt

shortlog: test and document --committer option

2016-12-16 09:39:10 -08:00

git-show-branch.txt

doc: typeset long command-line options as literal

2016-06-28 08:36:45 -07:00

git-show-index.txt

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

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

git-show-ref.txt

doc: typeset long command-line options as literal

2016-06-28 08:36:45 -07:00

git-show.txt

doc: convert \--option to --option

2015-05-12 22:14:46 -07:00

git-stage.txt

Documentation: adjust document title underlining

2014-10-13 13:35:18 -07:00

git-stash.txt

stash: update documentation to use 'stash entry'

2017-06-18 22:16:36 -07:00

git-status.txt

git-status.txt: mention --no-optional-locks

2017-11-27 15:09:56 +09: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 'sb/submodule-doc'

2017-07-12 15:18:21 -07:00

git-svn.txt

git-svn: document special options for commit-diff

2017-06-15 01:09:31 +00:00

git-symbolic-ref.txt

git symbolic-ref --delete $symref

2012-10-21 12:17:38 -07:00

git-tag.txt

Merge branch 'mg/format-ref-doc-fix' into maint

2017-09-10 17:03:06 +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

Documentation/git-update-index: explain splitIndex.*

2017-03-06 12:09:28 -08:00

git-update-ref.txt

update-ref and tag: add --create-reflog arg

2015-07-21 14:08:35 -07:00

git-update-server-info.txt

…

git-upload-archive.txt

Documentation: match underline with the text

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

git-upload-pack.txt

upload-pack.c: use parse-options API

2016-05-31 10:17:20 -07:00

git-var.txt

Documentation: the name of the system is 'Git', not 'git'

2013-02-01 13:53:33 -08: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-pack.txt: fix inconsistent spelling of "packfile"

2015-05-17 11:24:57 -07:00

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: typeset long command-line options as literal

2016-06-28 08:36:45 -07:00

git-whatchanged.txt

whatchanged: document its historical nature

2013-08-13 09:01:54 -07:00

git-worktree.txt

worktree add: add --lock option

2017-04-20 17:59:02 -07:00

git-write-tree.txt

…

git.txt

git: add --no-optional-locks option

2017-09-27 16:11:01 +09:00

gitattributes.txt

Merge branch 'ls/filter-process-delayed' into jt/subprocess-handshake

2017-07-26 12:56:19 -07:00

gitcli.txt

stash: update documentation to use 'stash entry'

2017-06-18 22:16:36 -07:00

gitcore-tutorial.txt

gitcore-tutorial: update broken link

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

gitcredentials.txt

credential doc: make multiple-helper behavior more prominent

2017-05-02 10:58:06 +09:00

gitcvs-migration.txt

Merge branch 'sb/doc-unify-bottom'

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

gitdiffcore.txt

docs/diffcore: unquote "Complete Rewrites" in headers

2017-02-28 11:34:38 -08:00

giteveryday.txt

giteveryday: unbreak rendering with AsciiDoctor

2017-01-07 14:03:40 -08:00

gitglossary.txt

Documentation: unify bottom "part of git suite" lines

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

githooks.txt

send-email: support validate hook

2017-05-16 11:13:00 +09:00

gitignore.txt

doc: change configuration variables format

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

gitk.txt

Merge branch 'sb/remove-gitview'

2017-01-18 15:12:18 -08:00

gitmodules.txt

Merge branch 'ss/submodule-shallow-doc'

2017-04-26 15:39:07 +09:00

gitnamespaces.txt

doc: mention transfer data leaks in more places

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

gitremote-helpers.txt

fix minor typos

2017-05-01 11:01:52 +09:00

gitrepository-layout.txt

Merge branch 'sb/doc-unify-bottom'

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

gitrevisions.txt

doc: gitrevisions - clarify 'latter case' is revision walk

2016-08-13 19:36:44 -07:00

gitsubmodules.txt

submodules: overhaul documentation

2017-06-22 15:25:25 -07:00

gittutorial-2.txt

Documentation: unify bottom "part of git suite" lines

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

gittutorial.txt

Documentation: unify bottom "part of git suite" lines

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

gitweb.conf.txt

doc: use https links to avoid http redirect

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

gitweb.txt

doc: use https links to Wikipedia to avoid http redirects

2017-05-15 13:04:54 +09:00

gitworkflows.txt

Documentation: unify bottom "part of git suite" lines

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

glossary-content.txt

glossary: define 'stash entry'

2017-06-18 22:18:15 -07:00

howto-index.sh

howto-index.sh: use the $( ... ) construct for command substitution

2014-04-17 11:14:57 -07:00

i18n.txt

doc: camelCase the i18n config variables to improve readability

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

install-doc-quick.sh

…

install-webdoc.sh

install-webdoc.sh: use the $( ... ) construct for command substitution

2014-04-17 11:14:58 -07:00

line-range-format.txt

Documentation: change -L:<regex> to -L:<funcname>

2015-04-20 11:05:50 -07:00

lint-gitlink.perl

ci: validate "linkgit:" in documentation

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

mailmap.txt

Merge branch 'jk/mailmap-from-blob'

2013-01-05 23:41:42 -08:00

Makefile

submodules: overhaul documentation

2017-06-22 15:25:25 -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

doc: change environment variables format

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

merge-options.txt

Merge branch 'kf/gpg-sig-verification-doc'

2016-05-17 14:38:39 -07:00

merge-strategies.txt

merge-strategies.txt: fix typo

2016-02-22 10:42:52 -08:00

pretty-formats.txt

pretty: respect color settings for %C placeholders

2017-07-13 12:42:51 -07:00

pretty-options.txt

Merge branch 'tr/doc-tt' into maint

2016-07-06 13:06:34 -07:00

pull-fetch-param.txt

docs: Explain the purpose of fetch's and pull's <refspec> parameter.

2014-06-12 09:59:13 -07:00

rev-list-options.txt

Merge branch 'rs/strbuf-addftime-zZ'

2017-06-22 14:15:25 -07:00

revisions.txt

Merge branch 'vn/revision-shorthand-for-side-branch-log'

2017-04-19 21:37:25 -07:00

sequencer.txt

…

SubmittingPatches

Merge branch 'rg/doc-submittingpatches-wordfix'

2017-05-04 16:26:46 +09:00

texi.xsl

Documentation: add XSLT to fix DocBook for Texinfo

2017-01-23 10:56:53 -08: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

transport: drop support for git-over-rsync

2016-02-01 13:07:41 -08:00

user-manual.conf

docs: monospace listings in docbook output

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

user-manual.txt

asciidoctor: fix user-manual to be built by asciidoctor

2017-01-13 10:30:16 -08:00