]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Merge branch 'ab/doc-synopsis-and-cmd-usage'
authorJunio C Hamano <gitster@pobox.com>
Fri, 28 Oct 2022 18:26:54 +0000 (11:26 -0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 28 Oct 2022 18:26:54 +0000 (11:26 -0700)
The short-help text shown by "git cmd -h" and the synopsis text
shown at the beginning of "git help cmd" have been made more
consistent.

* ab/doc-synopsis-and-cmd-usage: (34 commits)
  tests: assert consistent whitespace in -h output
  tests: start asserting that *.txt SYNOPSIS matches -h output
  doc txt & -h consistency: make "worktree" consistent
  worktree: define subcommand -h in terms of command -h
  reflog doc: list real subcommands up-front
  doc txt & -h consistency: make "commit" consistent
  doc txt & -h consistency: make "diff-tree" consistent
  doc txt & -h consistency: use "[<label>...]" for "zero or more"
  doc txt & -h consistency: make "annotate" consistent
  doc txt & -h consistency: make "stash" consistent
  doc txt & -h consistency: add missing options
  doc txt & -h consistency: use "git foo" form, not "git-foo"
  doc txt & -h consistency: make "bundle" consistent
  doc txt & -h consistency: make "read-tree" consistent
  doc txt & -h consistency: make "rerere" consistent
  doc txt & -h consistency: add missing options and labels
  doc txt & -h consistency: make output order consistent
  doc txt & -h consistency: add or fix optional "--" syntax
  doc txt & -h consistency: fix mismatching labels
  doc SYNOPSIS & -h: use "-" to separate words in labels, not "_"
  ...

19 files changed:
1  2 
Documentation/CodingGuidelines
Documentation/git-clean.txt
Documentation/git-commit-graph.txt
Documentation/git-interpret-trailers.txt
Documentation/git-show-branch.txt
Documentation/git-stash.txt
builtin/commit-graph.c
builtin/commit.c
builtin/describe.c
builtin/diagnose.c
builtin/diff.c
builtin/fsck.c
builtin/help.c
builtin/pack-objects.c
builtin/show-branch.c
builtin/show-ref.c
builtin/stash.c
builtin/symbolic-ref.c
help.c

Simple merge
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge
diff --cc builtin/diff.c
Simple merge
diff --cc builtin/fsck.c
Simple merge
diff --cc builtin/help.c
Simple merge
Simple merge
Simple merge
Simple merge
diff --cc builtin/stash.c
Simple merge
index 590ed17dd3f52934ff5cd3bcdd4070ac3d015105,50b6df78df04e8ef70f74b2332ffb6db566e74bb..e00768a8b7ec48b04f670087730495b50353787e
@@@ -5,8 -5,9 +5,9 @@@
  #include "parse-options.h"
  
  static const char * const git_symbolic_ref_usage[] = {
-       N_("git symbolic-ref [<options>] <name> [<ref>]"),
-       N_("git symbolic-ref -d [-q] [--no-recurse] <name>"),
+       N_("git symbolic-ref [-m <reason>] <name> <ref>"),
 -      N_("git symbolic-ref [-q] [--short] <name>"),
++      N_("git symbolic-ref [-q] [--short] [--no-recurse] <name>"),
+       N_("git symbolic-ref --delete [-q] <name>"),
        NULL
  };
  
diff --cc help.c
Simple merge