Ævar Arnfjörð Bjarmason d4056dba1f doc txt & -h consistency: fix incorrect alternates syntax ... Fix the incorrect "[-o | --option <argument>]" syntax, which should be "[(-o | --option) <argument>]", we were previously claiming that only the long option accepted the "<argument>", which isn't what we meant. This syntax issue for "bugreport" originated in 238b439d69 (bugreport: add tool to generate debugging info, 2020-04-16), and for "diagnose" in 6783fd3cef (builtin/diagnose.c: create 'git diagnose' builtin, 2022-08-12), which copied and adjusted "bugreport" documentation and code. In the case of "Documentation/git-stash.txt" and "builtin/stash.c" this is not a "doc txt & -h consistency" change, as we're changing both versions, doing so here makes a subsequent change smaller. In that case fix the incorrect "[-o | --option <argument>]" syntax, which should be "[(-o | --option) <argument>]", we were previously claiming that only the long option accepted the "<argument>", which isn't what we meant. The "stash" issue has been with us in both the "-h" and *.txt versions since bd514cada4 (stash: introduce 'git stash store', 2013-06-15). We could claim that this isn't a syntax issue if a "vertical bar binds tighter than option and its argument", but such a rule would change e.g. this "cat-file" SYNOPSIS example to mean something we don't: ... [<rev>:<path|tree-ish> | --path=<path|tree-ish> <rev>] We have various other examples where the post-image here is already used, e.g. for "format-patch" ("-o"), "grep" ("-m"), "submodule" ("set-branch -b") etc. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>		2022-10-13 09:32:55 -07:00
..
RelNotes	The eighteenth batch	2022-09-05 18:33:41 -07:00
config	Merge branch 'ac/bitmap-lookup-table'	2022-09-05 18:33:39 -07:00
howto	docs: move pack format docs to man section 5	2022-08-04 14:12:24 -07:00
mergetools	…
technical	Merge branch 'ac/bitmap-lookup-table'	2022-09-05 18:33:39 -07:00
.gitattributes	…
.gitignore	…
CodingGuidelines	CodingGuidelines: update and clarify command-line conventions	2022-10-13 09:32:54 -07:00
Makefile	Merge branch 'ds/bundle-uri-more'	2022-08-18 13:07:04 -07:00
MyFirstContribution.txt	…
MyFirstObjectWalk.txt	…
SubmittingPatches	…
ToolsForGit.txt	…
asciidoc.conf	…
asciidoctor-extensions.rb	…
blame-options.txt	…
build-docdep.perl	…
cat-texi.perl	…
cmd-list.perl	…
config.txt	Merge branch 'mb/config-document-include' into maint	2022-08-05 15:51:36 -07:00
date-formats.txt	…
diff-format.txt	…
diff-generate-patch.txt	…
diff-options.txt	…
doc-diff	…
docbook-xsl.css	…
docbook.xsl	…
everyday.txto	…
fetch-options.txt	…
fix-texi.perl	…
git-add.txt	doc add: renormalize is not idempotent for CRCRLF	2022-08-10 11:26:38 -07:00
git-am.txt	doc: consolidate --rerere-autoupdate description	2022-08-03 13:47:11 -07:00
git-annotate.txt	…
git-apply.txt	…
git-archimport.txt	…
git-archive.txt	…
git-bisect-lk2009.txt	…
git-bisect.txt	…
git-blame.txt	…
git-branch.txt	…
git-bugreport.txt	builtin/bugreport.c: create '--diagnose' option	2022-08-12 13:20:02 -07:00
git-bundle.txt	docs: move pack format docs to man section 5	2022-08-04 14:12:24 -07:00
git-cat-file.txt	Merge branch 'tb/cat-file-z'	2022-08-05 15:52:14 -07:00
git-check-attr.txt	…
git-check-ignore.txt	…
git-check-mailmap.txt	…
git-check-ref-format.txt	…
git-checkout-index.txt	…
git-checkout.txt	…
git-cherry-pick.txt	doc: consolidate --rerere-autoupdate description	2022-08-03 13:47:11 -07:00
git-cherry.txt	…
git-citool.txt	…
git-clean.txt	…
git-clone.txt	clone: --bundle-uri cannot be combined with --depth	2022-08-10 14:07:37 -07:00
git-column.txt	…
git-commit-graph.txt	docs: move commit-graph format docs to man section 5	2022-08-04 14:12:23 -07:00
git-commit-tree.txt	…
git-commit.txt	…
git-config.txt	…
git-count-objects.txt	…
git-credential-cache--daemon.txt	…
git-credential-cache.txt	…
git-credential-store.txt	…
git-credential.txt	…
git-cvsexportcommit.txt	…
git-cvsimport.txt	…
git-cvsserver.txt	…
git-daemon.txt	…
git-describe.txt	…
git-diagnose.txt	builtin/diagnose.c: add '--mode' option	2022-08-12 13:20:02 -07:00
git-diff-files.txt	…
git-diff-index.txt	…
git-diff-tree.txt	…
git-diff.txt	…
git-difftool.txt	…
git-fast-export.txt	doc SYNOPSIS: consistently use ' for commands	2022-10-13 09:32:54 -07:00
git-fast-import.txt	…
git-fetch-pack.txt	…
git-fetch.txt	…
git-filter-branch.txt	…
git-fmt-merge-msg.txt	…
git-for-each-ref.txt	…
git-for-each-repo.txt	…
git-format-patch.txt	…
git-fsck-objects.txt	…
git-fsck.txt	…
git-fsmonitor--daemon.txt	…
git-gc.txt	…
git-get-tar-commit-id.txt	…
git-grep.txt	…
git-gui.txt	…
git-hash-object.txt	doc txt & -h consistency: word-wrap	2022-10-13 09:32:55 -07:00
git-help.txt	git docs: add a category for file formats, protocols and interfaces	2022-08-04 14:12:23 -07:00
git-hook.txt	…
git-http-backend.txt	…
git-http-fetch.txt	…
git-http-push.txt	…
git-imap-send.txt	…
git-index-pack.txt	…
git-init-db.txt	…
git-init.txt	…
git-instaweb.txt	…
git-interpret-trailers.txt	…
git-log.txt	log: create log.initialDecorationSet=all	2022-08-05 14:13:12 -07:00
git-ls-files.txt	ls-files: introduce "--format" option	2022-07-23 10:53:55 -07:00
git-ls-remote.txt	…
git-ls-tree.txt	…
git-mailinfo.txt	…
git-mailsplit.txt	…
git-maintenance.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: consolidate --rerere-autoupdate description	2022-08-03 13:47:11 -07:00
git-mergetool--lib.txt	…
git-mergetool.txt	…
git-mktag.txt	…
git-mktree.txt	…
git-multi-pack-index.txt	docs: move pack format docs to man section 5	2022-08-04 14:12:24 -07:00
git-mv.txt	…
git-name-rev.txt	…
git-notes.txt	…
git-p4.txt	…
git-pack-objects.txt	…
git-pack-redundant.txt	…
git-pack-refs.txt	…
git-patch-id.txt	…
git-prune-packed.txt	…
git-prune.txt	…
git-pull.txt	…
git-push.txt	…
git-quiltimport.txt	…
git-range-diff.txt	…
git-read-tree.txt	…
git-rebase.txt	Merge branch 'jc/rerere-autoupdate-doc'	2022-08-14 23:19:27 -07:00
git-receive-pack.txt	…
git-reflog.txt	doc SYNOPSIS: don't use ' for subcommands	2022-10-13 09:32:54 -07:00
git-remote-ext.txt	…
git-remote-fd.txt	…
git-remote-helpers.txto	…
git-remote.txt	…
git-repack.txt	…
git-replace.txt	…
git-request-pull.txt	…
git-rerere.txt	doc SYNOPSIS: don't use ' for subcommands	2022-10-13 09:32:54 -07:00
git-reset.txt	…
git-restore.txt	…
git-rev-list.txt	…
git-rev-parse.txt	…
git-revert.txt	doc: consolidate --rerere-autoupdate description	2022-08-03 13:47:11 -07:00
git-rm.txt	…
git-send-email.txt	…
git-send-pack.txt	…
git-sh-i18n--envsubst.txt	…
git-sh-i18n.txt	…
git-sh-setup.txt	…
git-shell.txt	…
git-shortlog.txt	…
git-show-branch.txt	…
git-show-index.txt	…
git-show-ref.txt	…
git-show.txt	…
git-sparse-checkout.txt	doc SYNOPSIS: consistently use ' for commands	2022-10-13 09:32:54 -07:00
git-stage.txt	…
git-stash.txt	doc txt & -h consistency: fix incorrect alternates syntax	2022-10-13 09:32:55 -07:00
git-status.txt	…
git-stripspace.txt	…
git-submodule.txt	…
git-svn.txt	…
git-switch.txt	…
git-symbolic-ref.txt	…
git-tag.txt	…
git-tools.txt	…
git-unpack-file.txt	…
git-unpack-objects.txt	…
git-update-index.txt	…
git-update-ref.txt	…
git-update-server-info.txt	…
git-upload-archive.txt	…
git-upload-pack.txt	docs: move http-protocol docs to man section 5	2022-08-04 14:12:24 -07:00
git-var.txt	…
git-verify-commit.txt	…
git-verify-pack.txt	…
git-verify-tag.txt	…
git-version.txt	…
git-web--browse.txt	…
git-whatchanged.txt	…
git-worktree.txt	doc txt & -h consistency: word-wrap	2022-10-13 09:32:55 -07:00
git-write-tree.txt	…
git.txt	Merge branch 'ab/tech-docs-to-help'	2022-08-14 23:19:28 -07:00
gitattributes.txt	…
gitcli.txt	…
gitcore-tutorial.txt	…
gitcredentials.txt	…
gitcvs-migration.txt	…
gitdiffcore.txt	…
giteveryday.txt	…
gitfaq.txt	…
gitformat-bundle.txt	docs: move protocol-related docs to man section 5	2022-08-04 14:12:23 -07:00
gitformat-chunk.txt	docs: move pack format docs to man section 5	2022-08-04 14:12:24 -07:00
gitformat-commit-graph.txt	docs: move pack format docs to man section 5	2022-08-04 14:12:24 -07:00
gitformat-index.txt	Merge branch 'ab/tech-docs-to-help'	2022-08-14 23:19:28 -07:00
gitformat-pack.txt	docs: move cruft pack docs to gitformat-pack	2022-08-04 14:12:24 -07:00
gitformat-signature.txt	docs: move signature docs to man section 5	2022-08-04 14:12:24 -07:00
gitglossary.txt	…
githooks.txt	…
gitignore.txt	…
gitk.txt	…
gitmailmap.txt	…
gitmodules.txt	…
gitnamespaces.txt	…
gitprotocol-capabilities.txt	docs: move protocol-related docs to man section 5	2022-08-04 14:12:23 -07:00
gitprotocol-common.txt	docs: move protocol-related docs to man section 5	2022-08-04 14:12:23 -07:00
gitprotocol-http.txt	docs: move http-protocol docs to man section 5	2022-08-04 14:12:24 -07:00
gitprotocol-pack.txt	docs: move http-protocol docs to man section 5	2022-08-04 14:12:24 -07:00
gitprotocol-v2.txt	docs: move http-protocol docs to man section 5	2022-08-04 14:12:24 -07:00
gitremote-helpers.txt	remote-curl: add 'get' capability	2022-08-10 14:07:37 -07:00
gitrepository-layout.txt	…
gitrevisions.txt	…
gitsubmodules.txt	…
gittutorial-2.txt	…
gittutorial.txt	…
gitweb.conf.txt	…
gitweb.txt	…
gitworkflows.txt	…
glossary-content.txt	…
howto-index.sh	…
i18n.txt	…
install-doc-quick.sh	…
install-webdoc.sh	…
line-range-format.txt	…
line-range-options.txt	…
lint-gitlink.perl	…
lint-man-end-blurb.perl	…
lint-man-section-order.perl	git docs: add a category for file formats, protocols and interfaces	2022-08-04 14:12:23 -07:00
manpage-base-url.xsl.in	…
manpage-bold-literal.xsl	…
manpage-normal.xsl	…
manpage-quote-apos.xsl	…
manpage.xsl	…
merge-options.txt	…
merge-strategies.txt	…
object-format-disclaimer.txt	…
pretty-formats.txt	…
pretty-options.txt	…
pull-fetch-param.txt	…
ref-reachability-filters.txt	…
rerere-options.txt	doc: clarify rerere-autoupdate	2022-08-03 13:57:25 -07:00
rev-list-description.txt	…
rev-list-options.txt	Merge branch 'en/ancestry-path-in-a-range'	2022-08-29 14:55:11 -07:00
revisions.txt	Merge branch 'tk/rev-parse-doc-clarify-at-u' into maint	2022-07-27 13:19:52 -07:00
sequencer.txt	…
signoff-option.txt	…
texi.xsl	…
trace2-target-values.txt	…
transfer-data-leaks.txt	…
urls-remotes.txt	…
urls.txt	…
user-manual.conf	…
user-manual.txt	docs: move pack format docs to man section 5	2022-08-04 14:12:24 -07:00