Kaartic Sivaraam c6342e0525 Doc/check-ref-format: clarify information about @{-N} syntax ...

When the N-th previous thing checked out syntax (@{-N}) is used
with '--branch' option of check-ref-format the result may not be
the name of a branch that currently exists or ever existed. This
is because @{-N} is used to refer to the N-th last checked out
"thing", which might be a commit object name if the previous check
out was a detached HEAD state; or a branch name, otherwise. The
documentation thus does a wrong thing by promoting it as the
"previous branch syntax".

State that @{-N} is the syntax for specifying "N-th last thing
checked out" and also state that the result of using @{-N} might
also result in an commit object name.

Signed-off-by: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

2017-12-19 10:00:45 -08:00

..

howto

doc: use https links to avoid http redirect

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

RelNotes

RelNotes: minor typo fixes in 2.16.0 draft

2017-12-14 10:46:09 -08:00

technical

Merge branch 'bw/protocol-v1'

2017-12-06 09:23:44 -08:00

.gitattributes

…

.gitignore

Documentation: convert SubmittingPatches to AsciiDoc

2017-11-13 13:25:19 +09: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 'jn/ssh-wrappers'

2017-12-06 09:23:45 -08: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-options.txt

Merge branch 'jc/ignore-cr-at-eol'

2017-11-27 11:06:31 +09: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: introduce "--renormalize"

2017-11-17 10:31:05 +09:00

git-am.txt

Merge branch 'mm/doc-tt'

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

git-annotate.txt

diff: --indent-heuristic is no longer experimental

2017-11-02 14:51:24 +09:00

git-apply.txt

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

2017-08-23 12:17:22 -07: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

bisect: mention "view" as an alternative to "visualize"

2017-11-13 10:51:14 +09:00

git-blame.txt

diff: --indent-heuristic is no longer experimental

2017-11-02 14:51:24 +09:00

git-branch.txt

Merge branch 'tz/branch-doc-remove-set-upstream'

2017-12-06 09:23:36 -08:00

git-bundle.txt

transport: drop support for git-over-rsync

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

git-cat-file.txt

doc: fix minor typos (extra/duplicated words)

2017-09-14 15:09:02 +09: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

Doc/check-ref-format: clarify information about @{-N} syntax

2017-12-19 10:00:45 -08:00

git-checkout-index.txt

…

git-checkout.txt

Merge branch 'ks/doc-checkout-previous'

2017-12-13 13:28:57 -08: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

config: add --expiry-date

2017-11-18 12:31:29 +09: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

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

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

git-daemon.txt

doc: typeset HEAD and variants as literal

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

git-describe.txt

describe: teach --match to handle branches and remotes

2017-09-20 13:30:10 +09:00

git-diff-files.txt

…

git-diff-index.txt

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

2017-08-23 12:17:22 -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

Merge branch 'dg/filter-branch-filter-order-doc'

2017-10-19 14:45:45 +09: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 'js/for-each-ref-remote-name-and-ref'

2017-11-15 12:14:32 +09:00

git-format-patch.txt

format-patch: have progress option while generating patches

2017-08-14 14:09:45 -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

Merge branch 'mr/doc-negative-pathspec' into maint

2017-10-18 14:19:12 +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

Merge branch 'jk/trailers-parse'

2017-08-26 22:55:04 -07:00

git-log.txt

log: add option to choose which refs to decorate

2017-11-22 13:18:59 +09:00

git-ls-files.txt

fsmonitor: add documentation for the fsmonitor extension.

2017-10-01 17:23:05 +09: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

merge-base --fork-point doc: clarify the example and failure modes

2017-11-09 12:28:30 +09: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

Merge branch 'wk/pull-signoff'

2017-11-06 14:24:24 +09: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

Merge branch 'rd/doc-notes-prune-fix'

2017-12-06 09:23:40 -08: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

prune: add "--progress" to man page and usage msg

2017-11-22 12:29:30 +09:00

git-pull.txt

Merge branch 'sb/pull-rebase-submodule'

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

git-push.txt

builtin/push.c: add push.pushOption config

2017-10-24 09:57:54 +09: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 'jk/doc-read-tree-table-asciidoctor-fix' into maint

2017-10-18 14:19:11 +09:00

git-rebase.txt

Merge branch 'js/rebase-i-final'

2017-10-03 15:42:47 +09: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

doc: add missing "-n" (dry-run) option to reflog man page

2017-11-22 12:24:47 +09: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

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

2017-08-23 12:17:22 -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

Merge branch 'sb/rev-parse-show-superproject-root'

2017-10-28 10:18:40 +09:00

git-revert.txt

doc: typeset long command-line options as literal

2016-06-28 08:36:45 -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

git-send-email: honor $PATH for sendmail binary

2017-11-28 10:14:30 +09:00

git-send-pack.txt

Merge branch 'ma/parse-maybe-bool'

2017-08-22 10:29:03 -07: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

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

doc: prefer 'stash push' over 'stash save'

2017-11-22 13:40:25 +09:00

git-status.txt

Merge branch 'jk/no-optional-locks'

2017-12-13 13:28:58 -08: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

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

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

git-symbolic-ref.txt

git symbolic-ref --delete $symref

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

git-tag.txt

Merge branch 'jk/ref-filter-colors-fix' into maint

2017-10-18 14:20:43 +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 'bp/fsmonitor'

2017-11-21 14:07:50 +09: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

Merge branch 'bw/protocol-v1'

2017-12-06 09:23:44 -08:00

gitattributes.txt

add: introduce "--renormalize"

2017-11-17 10:31:05 +09:00

gitcli.txt

stash: update documentation to use 'stash entry'

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

gitcore-tutorial.txt

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

2017-08-23 12:17:22 -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

Merge branch 'jc/receive-pack-hook-doc'

2017-12-13 13:28:55 -08: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 'sp/doc-info-attributes'

2017-12-06 09:23:43 -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

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

2017-08-23 12:17:22 -07: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

stash: replace "git stash save" with "git stash push" in the documentation

2017-10-27 09:58:38 +09:00

glossary-content.txt

Merge branch 'mr/doc-negative-pathspec' into maint

2017-10-18 14:19:12 +09: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

Documentation: convert SubmittingPatches to AsciiDoc

2017-11-13 13:25:19 +09: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 'wk/pull-signoff'

2017-11-06 14:24:24 +09:00

merge-strategies.txt

Merge branch 'jc/ignore-cr-at-eol'

2017-11-27 11:06:31 +09:00

pretty-formats.txt

Merge branch 'jk/trailers-parse'

2017-08-26 22:55:04 -07:00

pretty-options.txt

Merge branch 'tr/doc-tt' into maint

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

pull-fetch-param.txt

fetch doc: src side of refspec could be full SHA-1

2017-10-18 05:59:34 +09:00

rev-list-options.txt

Merge branch 'sg/rev-list-doc-reorder-fix'

2017-10-28 10:18:42 +09: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 'bc/submitting-patches-in-asciidoc' into maint

2017-12-06 09:08:59 -08: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

stash: replace "git stash save" with "git stash push" in the documentation

2017-10-27 09:58:38 +09:00