git-fast-import(1): remove duplicate "--done" option
PATCH 1/1 git-fast-import(1): remove duplicate "--done" option
The "--done" option to git-fast-import is documented twice in its manual page. Combine the best bits of each description, keeping the location of the instance that was added first.
---
I'm guessing that the reason the option was documented again (in commit 3266de10) is because the options are not in an obvious order. There does seem to be some grouping of the options by type, but without subheadings I wonder if it would make more sense to just put them all in alphabetical order?
Documentation/git-fast-import.txt | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-)
Documentation/git-fast-import.txt +2 -5
@@ -39,10 +39,6 @@ OPTIONS See ``Date Formats'' below for details about which formats are supported, and their syntax. --- done:: - Terminate with error if there is no 'done' command at the - end of the stream. - --force:: Force updating modified existing branches, even if doing so would cause commits to be lost (as the new commit does
@@ -108,7 +104,8 @@ OPTIONS output. --done:: - Require a `done` command at the end of the stream. + Terminate with error if there is no 'done' command at the + end of the stream. This option might be useful for detecting errors that cause the frontend to terminate before it has started to write a stream.
Signature · 1 line
1.8.0.2
John Keeping <[email protected]>:
Quoted 5 lines
I'm guessing that the reason the option was documented again (in commit
3266de10) is because the options are not in an obvious order. There does seem to be some grouping of the options by type, but without subheadings I wonder if it would make more sense to just put them all in alphabetical order?
+1
This duplication originated with me. I'll apologize with a reordering patch.
Signature · 1 line
<a href="http://www.catb.org/~esr/">Eric S. Raymond</a>
Quoted 5 lines · John Keeping
The "--done" option to git-fast-import is documented twice in its manual page. Combine the best bits of each description, keeping the location of the instance that was added first.
Signed-off-by John Keeping <[email protected]>
Good catch, thanks.
PATCH v2 1/1 git-fast-import(1): remove duplicate '--done' option
In reply to John KeepingOn Sat, Jan 05, 2013 at 04:06:52PM +0000, John Keeping wrote:
The '--done' option to git-fast-import is documented twice in its manual page. Combine the best bits of each description, keeping the location of the instance that was added first.
---
Changed since v1:
'done' => `done`
I'll wait a bit longer for comments on [1] before I have another go at the full re-organisation of this page.
[1] http://article.gmane.org/gmane.comp.version-control.git/212805
Documentation/git-fast-import.txt | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-)
Documentation/git-fast-import.txt +2 -5
@@ -39,10 +39,6 @@ OPTIONS See ``Date Formats'' below for details about which formats are supported, and their syntax. --- done:: - Terminate with error if there is no 'done' command at the - end of the stream. - --force:: Force updating modified existing branches, even if doing so would cause commits to be lost (as the new commit does
@@ -108,7 +104,8 @@ OPTIONS output. --done:: - Require a `done` command at the end of the stream. + Terminate with error if there is no `done` command at the + end of the stream. This option might be useful for detecting errors that cause the frontend to terminate before it has started to write a stream.
Signature · 1 line
1.8.0.2
PATCH v3 1/1 git-fast-import(1): remove duplicate '--done' option
In reply to John KeepingThe '--done' option to git-fast-import is documented twice in its manual page. Combine the best bits of each description, keeping the location of the instance that was added first.
---
The commit description gained some noise in v2; this version should be the really correct, final version.
Sorry for the noise.
Documentation/git-fast-import.txt | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-)
Documentation/git-fast-import.txt +2 -5
@@ -39,10 +39,6 @@ OPTIONS See ``Date Formats'' below for details about which formats are supported, and their syntax. --- done:: - Terminate with error if there is no 'done' command at the - end of the stream. - --force:: Force updating modified existing branches, even if doing so would cause commits to be lost (as the new commit does
@@ -108,7 +104,8 @@ OPTIONS output. --done:: - Require a `done` command at the end of the stream. + Terminate with error if there is no `done` command at the + end of the stream. This option might be useful for detecting errors that cause the frontend to terminate before it has started to write a stream.
Signature · 1 line
1.8.0.2