[PATCH 0/17] Documentation fixes in response to my previous listing

DORMANTno replies

19 messages, 2 authors, 2016-06-15 · open the first message on its own page

[PATCH 0/17] Documentation fixes in response to my previous listing

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

This is a series of patches that fix small issues with the documentation.
This includes missing option-aliases, missing options, and broken formatting.

        nikolai

---
 Documentation/git-am.txt                 |    2 +-
 Documentation/git-cherry-pick.txt        |    6 ++---
 Documentation/git-commit.txt             |   18 +++++++++-----
 Documentation/git-cvsimport.txt          |    2 +-
 Documentation/git-format-patch.txt       |   23 +++++++++++++----
 Documentation/git-http-fetch.txt         |    6 +++++
 Documentation/git-ls-remote.txt          |    2 +-
 Documentation/git-merge-index.txt        |    2 +-
 Documentation/git-pack-objects.txt       |    6 ++++-
 Documentation/git-prune.txt              |   10 +++++++-
 Documentation/git-read-tree.txt          |    2 +-
 Documentation/git-repack.txt             |    9 ++++++-
 Documentation/git-revert.txt             |    4 ++-
 Documentation/git-show-branch.txt        |    8 +++++-
 Documentation/git-tag.txt                |   40 +++++++++++++++---------------
 Documentation/git-update-server-info.txt |    2 +-
 Documentation/git-verify-pack.txt        |    4 ++-
 git-revert.sh                            |    2 +-
 pack-objects.c                           |    2 +-
 show-branch.c                            |    2 +-
 20 files changed, 101 insertions(+), 51 deletions(-)

[PATCH 3/17] Use uniform description for the '--' option.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

All descriptions of the '--' option were the same except for that in
Documentation/git-merge-index.txt.

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-merge-index.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

54160acf1b953d34c161b27aa2b320bbf61ac86e
diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt
index 6030642..fbc986a 100644
--- a/Documentation/git-merge-index.txt
+++ b/Documentation/git-merge-index.txt
@@ -20,7 +20,7 @@ files are passed as arguments 5, 6 and 7
 OPTIONS
 -------
 --::
-	Interpret all following arguments as filenames.
+	Do not interpret any more arguments as options.
 
 -a::
 	Run merge against all files in the index that need merging.
-- 
0.99.9l

[PATCH 1/17] Document the --non-empty command-line option to git-pack-objects.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

This provides (minimal) documentation for the --non-empty command-line
option to the pack-objects command.

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-pack-objects.txt |    6 +++++-
 pack-objects.c                     |    2 +-
 2 files changed, 6 insertions(+), 2 deletions(-)

50543554f2945443c10434fcfe6689bc7cc5c3e8
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index d1e93db..009ec5a 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -8,7 +8,7 @@ git-pack-objects - Create a packed archi
 
 SYNOPSIS
 --------
-'git-pack-objects' [--local] [--incremental] [--window=N] [--depth=N] {--stdout | base-name} < object-list
+'git-pack-objects' [--non-empty] [--local] [--incremental] [--window=N] [--depth=N] {--stdout | base-name} < object-list
 
 
 DESCRIPTION
@@ -70,6 +70,10 @@ base-name::
 	that are packed and not in the local object store
 	(i.e. borrowed from an alternate).
 
+--non-empty::
+        Only create a packed archive if it would contain at
+        least one object.
+
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
diff --git a/pack-objects.c b/pack-objects.c
index a62c9f8..caf3b6b 100644
--- a/pack-objects.c
+++ b/pack-objects.c
@@ -4,7 +4,7 @@
 #include "pack.h"
 #include "csum-file.h"
 
-static const char pack_usage[] = "git-pack-objects [--local] [--incremental] [--window=N] [--depth=N] {--stdout | base-name} < object-list";
+static const char pack_usage[] = "git-pack-objects [--non-empty] [--local] [--incremental] [--window=N] [--depth=N] {--stdout | base-name} < object-list";
 
 struct object_entry {
 	unsigned char sha1[20];
-- 
0.99.9l

[PATCH 8/17] Documentation/git-cherry-pick: Add --replay and --no-commit.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-cherry-pick.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

e0a7bc3c18f904afade2da6146aeba4c5aa68340
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index a7a883b..744f2c9 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -24,7 +24,7 @@ OPTIONS
 	With this option, `git-cherry-pick` will let you edit the commit
 	message prior committing.
 
--r::
+-r|--replay::
 	Usually the command appends which commit was
 	cherry-picked after the original commit message when
 	making a commit.  This option, '--replay', causes it to
@@ -32,7 +32,7 @@ OPTIONS
 	when you are reordering the patches in your private tree
 	before publishing.
 
--n::
+-n|--no-commit::
 	Usually the command automatically creates a commit with
 	a commit log message stating which commit was
 	cherry-picked.  This flag applies the change necessary
-- 
0.99.9l

[PATCH 15/17] Documentation/git-update-server-info.txt: Add -f alias for --force to documentation.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-update-server-info.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

32baeb613526b51ebc7689311ec0a164fdc36c27
diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt
index 3d0dea0..527fb30 100644
--- a/Documentation/git-update-server-info.txt
+++ b/Documentation/git-update-server-info.txt
@@ -22,7 +22,7 @@ pull decisions.  This command generates 
 OPTIONS
 -------
 
---force::
+-f|--force::
 	Update the info files from scratch.
 
 
-- 
0.99.9l

[PATCH 17/17] Documentation/git-read-tree.txt: Add --reset to SYNOPSIS.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-read-tree.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

2464fb38eb9ce5c1dcf9eec6aea809454a5ef770
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index 27ee590..6fbd6d9 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -8,7 +8,7 @@ git-read-tree - Reads tree information i
 
 SYNOPSIS
 --------
-'git-read-tree' (<tree-ish> | [-m [-u|-i]] <tree-ish1> [<tree-ish2> [<tree-ish3>]])
+'git-read-tree' (<tree-ish> | [[-m | --reset] [-u | -i]] <tree-ish1> [<tree-ish2> [<tree-ish3>]])
 
 
 DESCRIPTION
-- 
0.99.9l

[PATCH 10/17] Add documentation for the --topo-order option to git-show-branch.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-show-branch.txt |    8 +++++++-
 show-branch.c                     |    2 +-
 2 files changed, 8 insertions(+), 2 deletions(-)

1458ff5267fcaa7b2178e53865cd5056e3776d8d
diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index 304101d..ffe64d8 100644
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -7,7 +7,7 @@ git-show-branch - Show branches and thei
 
 SYNOPSIS
 --------
-'git-show-branch [--all] [--heads] [--tags] [--more=<n> | --list | --independent | --merge-base] [--no-name | --sha1-name] [<rev> | <glob>]...'
+'git-show-branch [--all] [--heads] [--tags] [--topo-order] [--more=<n> | --list | --independent | --merge-base] [--no-name | --sha1-name] [<rev> | <glob>]...'
 
 DESCRIPTION
 -----------
@@ -35,6 +35,12 @@ OPTIONS
 	Show all refs under $GIT_DIR/refs, $GIT_DIR/refs/heads,
 	and $GIT_DIR/refs/tags, respectively.
 
+--topo-order::
+        By default, the branches and their commits are shown in
+        reverse chronological order.  This option makes them
+        appear in topological order (i.e., descendant commits
+        are shown before their parents).
+
 --more=<n>::
 	Usually the command stops output upon showing the commit
 	that is the common ancestor of all the branches.  This
diff --git a/show-branch.c b/show-branch.c
index bff690d..64a55dc 100644
--- a/show-branch.c
+++ b/show-branch.c
@@ -5,7 +5,7 @@
 #include "refs.h"
 
 static const char show_branch_usage[] =
-"git-show-branch [--all] [--heads] [--tags] [--more=count | --list | --independent | --merge-base ] [<refs>...]";
+"git-show-branch [--all] [--heads] [--tags] [--topo-order] [--more=count | --list | --independent | --merge-base ] [<refs>...]";
 
 #define UNINTERESTING	01
 
-- 
0.99.9l

[PATCH 12/17] Documentation/git-ls-remote.txt: Add -h and -t.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

-h and -t are aliases for --heads and --tags to git-ls-remote.

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-ls-remote.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

763853d9c9f2b9c0f5c76138f081d13640a24666
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index c0a80d4..66fe60f 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -17,7 +17,7 @@ Displays the references other repository
 
 OPTIONS
 -------
---heads --tags::
+-h|--heads, -t|--tags::
 	Limit to only refs/heads and refs/tags, respectively.
 	These options are _not_ mutually exclusive; when given
 	both, references stored in refs/heads and refs/tags are
-- 
0.99.9l

[PATCH 7/17] Documentation/git-cvsimport.txt: Fix a slight glitch in description heading.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-cvsimport.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

98723ba21e0ffdbfc183a2b878938ab17744317d
diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index 88bd3b0..f89b251 100644
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -60,7 +60,7 @@ the old cvs2git tool.
 +
 If you need to pass multiple options, separate them with a comma.
 
--P:: <cvsps-output-file>
+-P <cvsps-output-file>::
 	Instead of calling cvsps, read the provided cvsps output file. Useful
 	for debugging or when cvsps is being handled outside cvsimport.
 
-- 
0.99.9l

[PATCH 14/17] Documentation/git-http-fetch.txt: Document the commit-id argument.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-http-fetch.txt |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)

3bd76463c218402e883fc5c173ba9b9af77640bf
diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt
index 088624f..1116e85 100644
--- a/Documentation/git-http-fetch.txt
+++ b/Documentation/git-http-fetch.txt
@@ -14,6 +14,12 @@ DESCRIPTION
 -----------
 Downloads a remote git repository via HTTP.
 
+OPTIONS
+-------
+commit-id::
+        Either the hash or the filename under [URL]/refs/ to
+        pull.
+
 -c::
 	Get the commit objects.
 -t::
-- 
0.99.9l

[PATCH 9/17] Add documentation for git-revert and git-cherry-pick.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

* Added the -e option to the documentation of git-cherry-pick.
* Added the -e and --no-commit option to git-revert.
* Removed redundant case expression for -n as --no-edit (already taken by
  --no-commit).

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-cherry-pick.txt |    2 +-
 Documentation/git-revert.txt      |    4 ++--
 git-revert.sh                     |    2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

d4736aca7d9e34a56c0c32130af057bc2b9f0dfa
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index 744f2c9..4f323fa 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -20,7 +20,7 @@ OPTIONS
 <commit>::
 	Commit to cherry-pick.
 
---edit::
+-e|--edit::
 	With this option, `git-cherry-pick` will let you edit the commit
 	message prior committing.
 
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index f471037..e27c680 100644
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -20,7 +20,7 @@ OPTIONS
 <commit>::
 	Commit to revert.
 
---edit::
+-e|--edit::
 	With this option, `git-revert` will let you edit the commit
 	message prior committing the revert. This is the default if
 	you run the command from a terminal.
@@ -29,7 +29,7 @@ OPTIONS
 	With this option, `git-revert` will not start the commit
 	message editor.
 
--n::
+-n|--no-commit::
 	Usually the command automatically creates a commit with
 	a commit log message stating which commit was reverted.
 	This flag applies the change necessary to revert the
diff --git a/git-revert.sh b/git-revert.sh
index 5cb02b1..9d499c4 100755
--- a/git-revert.sh
+++ b/git-revert.sh
@@ -38,7 +38,7 @@ do
 	-e|--e|--ed|--edi|--edit)
 		edit=-e
 		;;
-	-n|--n|--no|--no-|--no-e|--no-ed|--no-edi|--no-edit)
+	--n|--no|--no-|--no-e|--no-ed|--no-edi|--no-edit)
 		edit=
 		;;
 	-r|--r|--re|--rep|--repl|--repla|--replay)
-- 
0.99.9l

[PATCH 13/17] Documentation/git-repack.txt: Add -l and -n.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

This adds documentation for the -l and -n options to git-repack.

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-repack.txt |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)

74b49b4c4f2e04066f36011215106627f3405338
diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
index 0c1ae49..9060fe8 100644
--- a/Documentation/git-repack.txt
+++ b/Documentation/git-repack.txt
@@ -9,7 +9,7 @@ objects into pack files.
 
 SYNOPSIS
 --------
-'git-repack' [-a] [-d]
+'git-repack' [-a] [-d] [-l] [-n]
 
 DESCRIPTION
 -----------
@@ -39,6 +39,13 @@ OPTIONS
 	After packing, if the newly created packs make some
 	existing packs redundant, remove the redundant packs.
 
+-l::
+        Pass the `--local` option to `git pack-objects`, see
+        gitlink:git-pack-objects[1].
+
+-n::
+        Do not update the server information with
+        `git update-server-info`.
 
 Author
 ------
-- 
0.99.9l

[PATCH 6/17] Document the [<head>...] and -- arguments to git-prune.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

The documentation for git-prune was lacking descriptions of the head
arguments and the -- option.

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-prune.txt |   10 +++++++++-
 1 files changed, 9 insertions(+), 1 deletions(-)

b4491eee9b9e371f4c9ea65c93be998a4f37498c
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
index 3367c9b..04cea76 100644
--- a/Documentation/git-prune.txt
+++ b/Documentation/git-prune.txt
@@ -8,7 +8,7 @@ git-prune - Prunes all unreachable objec
 
 SYNOPSIS
 --------
-'git-prune' [-n]
+'git-prune' [-n] [--] [<head>...]
 
 DESCRIPTION
 -----------
@@ -26,7 +26,15 @@ OPTIONS
 -n::
 	Do not remove anything; just report what it would
 	remove.
+--::
+	Do not interpret any more arguments as options.
 
+<head>...::
+        The heads to look for unreachable objects in.  This is
+        relative to $GIT_DIR (e.g., "HEAD", "refs/heads/master").
+        When unspecified, all heads are updated to match the
+        remote repository.
+        
 
 Author
 ------
-- 
0.99.9l

[PATCH 5/17] Documentation/git-verify-pack.txt: added documentation for --.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

The -- option has been added to the documentation of git-verify-pack.

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-verify-pack.txt |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

ab7a137fa6d4629578c0d2b580189d58d556fa13
diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt
index cd74ffd..d032280 100644
--- a/Documentation/git-verify-pack.txt
+++ b/Documentation/git-verify-pack.txt
@@ -8,7 +8,7 @@ git-verify-pack - Validate packed git ar
 
 SYNOPSIS
 --------
-'git-verify-pack' [-v] <pack>.idx ...
+'git-verify-pack' [-v] [--] <pack>.idx ...
 
 
 DESCRIPTION
@@ -25,6 +25,8 @@ OPTIONS
 -v::
 	After verifying the pack, show list of objects contained
 	in the pack.
+--::
+	Do not interpret any more arguments as options.
 
 OUTPUT FORMAT
 -------------
-- 
0.99.9l

[PATCH 16/17] Documentation/git-tag.txt: Fix the order of sections (DESCRIPTION should come before OPTIONS).

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-tag.txt |   40 ++++++++++++++++++++--------------------
 1 files changed, 20 insertions(+), 20 deletions(-)

4e7e431f15e54257e78beb23644bddffc6357c9b
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 841c9dc..e8892bb 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -10,26 +10,6 @@ SYNOPSIS
 --------
 'git-tag' [-a | -s | -u <key-id>] [-f | -d] [-m <msg>] <name> [<head>]
 
-OPTIONS
--------
--a::
-	Make an unsigned, annotated tag object
-
--s::
-	Make a GPG-signed tag, using the default e-mail address's key
-
--u <key-id>::
-	Make a GPG-signed tag, using the given key
-
--f::
-	Replace an existing tag with the given name (instead of failing)
-
--d::
-	Delete an existing tag with the given name
-
--m <msg>::
-	Use the given tag message (instead of prompting)
-
 DESCRIPTION
 -----------
 Adds a 'tag' reference in .git/refs/tags/
@@ -52,6 +32,26 @@ GnuPG key for signing.
 
 `-d <tag>` deletes the tag.
 
+OPTIONS
+-------
+-a::
+	Make an unsigned, annotated tag object
+
+-s::
+	Make a GPG-signed tag, using the default e-mail address's key
+
+-u <key-id>::
+	Make a GPG-signed tag, using the given key
+
+-f::
+	Replace an existing tag with the given name (instead of failing)
+
+-d::
+	Delete an existing tag with the given name
+
+-m <msg>::
+	Use the given tag message (instead of prompting)
+
 
 Author
 ------
-- 
0.99.9l

[PATCH 2/17] Fix the description of --utf8 and --keep to git-am.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

The git-am script actually transform --utf8 and --keep to -u and -k when
sent to git-mailinfo.

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-am.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

c11386158dd597184fbc14df5f728bddd23b3d17
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 1ceed11..6645e82 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -28,7 +28,7 @@ OPTIONS
 	area to store extracted patches.
 
 --utf8, --keep::
-	Pass `--utf8` and `--keep` flags to `git-mailinfo` (see
+	Pass `-u` and `-k` flags to `git-mailinfo` (see
 	gitlink:git-mailinfo[1]).
 
 --binary::
-- 
0.99.9l

[PATCH 11/17] Documentation/git-format-patch.txt: Add --signoff, --check, and long option-names.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

The documentation was lacking descriptions for the --signoff and --check
options to git-format-patch.  It was also missing the following long
option-names: --output-directory (-o), --numbered (-n), --keep-subject
(-k), --author (-a), --date (-d), and --mbox (-m).

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-format-patch.txt |   23 +++++++++++++++++------
 1 files changed, 17 insertions(+), 6 deletions(-)

be287ad64c289c1e3ff43e0784392bda3bbe3557
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 7a3abec..abb8fc8 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -8,7 +8,7 @@ git-format-patch - Prepare patches for e
 
 SYNOPSIS
 --------
-'git-format-patch' [-n][-o <dir>|--stdout][-k][--mbox][--diff-options] <his> [<mine>]
+'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] [--diff-options] <his> [<mine>]
 
 DESCRIPTION
 -----------
@@ -32,23 +32,34 @@ processing with applymbox.
 
 OPTIONS
 -------
--o <dir>::
+-o|--output-directory <dir>::
 	Use <dir> to store the resulting files, instead of the
 	current working directory.
 
--n::
+-n|--numbered::
 	Name output in '[PATCH n/m]' format.
 
--k::
+-k|--keep-subject::
 	Do not strip/add '[PATCH]' from the first line of the
 	commit log message.
 
---author, --date::
+-a|--author, -d|--date::
 	Output From: and Date: headers for commits made by
 	yourself as well.  Usually these are output only for
 	commits made by people other than yourself.
 
---mbox::
+-s|--signoff::
+	Add `Signed-off-by:` line to the commit message, using
+	the committer identity of yourself.
+
+-c|--check::
+        Display suspicious lines in the patch.  The definition
+        of 'suspicious lines' is currently the lines that has
+        trailing whitespaces, and the lines whose indentation
+        has a SP character immediately followed by a TAB
+        character.
+
+-m|--mbox::
 	Format the output files for closer to mbox format by
 	adding a phony Unix "From " line, so they can be
 	concatenated together and fed to `git-applymbox`.
-- 
0.99.9l

[PATCH 4/17] Documentation/git-commit.txt: Add long options and -- to documentation.

From: Nikolai Weibull <hidden>
Date: 2016-06-15 22:42:14

Added the following long options to documentation:

* --all
* --signoff
* --verify
* --no-verify
* --edit

Also added documentation for the -- option for terminating option parsing.

Signed-off-by: Nikolai Weibull <redacted>

---

 Documentation/git-commit.txt |   18 ++++++++++++------
 1 files changed, 12 insertions(+), 6 deletions(-)

f0cc0137f124e36fd31acb8d0d543bdc84923586
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 1edc278..b92cf48 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -7,7 +7,7 @@ git-commit - Record your changes
 
 SYNOPSIS
 --------
-'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] <file>...
+'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] [--] <file>...
 
 DESCRIPTION
 -----------
@@ -22,7 +22,7 @@ information.
 
 OPTIONS
 -------
--a::
+-a|--all::
 	Update all paths in the index file.
 
 -c or -C <commit>::
@@ -39,23 +39,29 @@ OPTIONS
 -m <msg>::
 	Use the given <msg> as the commit message.
 
--s::
+-s|--signoff::
 	Add Signed-off-by line at the end of the commit message.
 
--v::
+-v|--verify::
 	Look for suspicious lines the commit introduces, and
 	abort committing if there is one.  The definition of
 	'suspicious lines' is currently the lines that has
 	trailing whitespaces, and the lines whose indentation
 	has a SP character immediately followed by a TAB
-	character.
+	character.  This is the default.
 
--e::
+-n|--no-verify::
+	The opposite of `--verify`.
+
+-e|--edit::
 	The message taken from file with `-F`, command line with
 	`-m`, and from file with `-C` are usually used as the
 	commit log message unmodified.  This option lets you
 	further edit the message taken from these sources.
 
+--::
+	Do not interpret any more arguments as options.
+
 <file>...::
 	Update specified paths in the index file before committing.
 
-- 
0.99.9l

Re: [PATCH 6/17] Document the [<head>...] and -- arguments to git-prune.

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:42:14

Nikolai Weibull [off-list ref] writes:
The documentation for git-prune was lacking descriptions of the head
arguments and the -- option.

+<head>...::
+        The heads to look for unreachable objects in.  This is
+        relative to $GIT_DIR (e.g., "HEAD", "refs/heads/master").
+        When unspecified, all heads are updated to match the
+        remote repository.
? updated to match???

All others look very good.  Thanks for taking time to do this;
very much appreciated.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help