[PATCH 2/4] fast-import: clarify documentation of "feature" command
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- Nov 28, 2010, 19:43 UTC
- Message-ID
- <20101128194357.GC19998@burratino>
- In-Reply-To
- <20101128194131.GA19998@burratino>
The "feature" command allows streams to specify options for the import that must not be ignored. Logically, they are part of the stream, even though technically most supported features are synonyms to command-line options.
Make this more obvious by being more explicit about how the analogy between most "feature" commands and command-line options works. Treat the feature (import-marks) that does not fit this analogy separately.
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> --- Side note: I am thinking of introducing a syntax
'feature' SP 'command' SP <command name> LF
which would just check if <command name> is a recognized command. This way, when a feature introduces a new command, it would get a feature name to go along with that with no extra effort.
In particular, it is not obvious to me whether cat-blob, ls-tree, and so on ought to be considered a single feature but with the feature command syntax, we could dodge the issue. :) Sane?
Documentation/git-fast-import.txt | 33 +++++++++++++++------------------ 1 files changed, 15 insertions(+), 18 deletions(-)
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 19082b0..3bf04e3 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -878,28 +878,25 @@ Require that fast-import supports the specified feature, or abort if it does not. .... - 'feature' SP <feature> LF + 'feature' SP <feature> ('=' <argument>)? LF .... -The <feature> part of the command may be any string matching -^[a-zA-Z][a-zA-Z-]*$ and should be understood by fast-import. +The <feature> part of the command may be any one of the following: -Feature work identical as their option counterparts with the -exception of the import-marks feature, see below. +date-format:: +export-marks:: +relative-marks:: +no-relative-marks:: +force:: + Act as though the corresponding command-line option with + a leading '--' was passed on the command line + (see OPTIONS, above). -The following features are currently supported: - -* date-format -* import-marks -* export-marks -* relative-marks -* no-relative-marks -* force - -The import-marks behaves differently from when it is specified as -commandline option in that only one "feature import-marks" is allowed -per stream. Also, any --import-marks= specified on the commandline -will override those from the stream (if any). +import-marks:: + Like --import-marks except in two respects: first, only one + "feature import-marks" command is allowed per stream; + second, an --import-marks= command-line option overrides + any "feature import-marks" command in the stream. `option` ~~~~~~~~