fast-import: clarify documentation of "feature" command
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> Signed-off-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Nieder committed
Nov 28, 2010 at 13:43 UTC
68595cd442caabbd8b43ff0789d2829454efff1b
1 file changed
+17
-20
Documentation/git-fast-import.txt
+17
-20
@@ -878,28 +878,25 @@ Require that fast-import supports the specified feature, or abort if
878
it does not.
879
880
....
881
- 'feature' SP <feature> LF
881
+ 'feature' SP <feature> ('=' <argument>)? LF
882
....
883
884
-The <feature> part of the command may be any string matching
885
-^[a-zA-Z][a-zA-Z-]*$ and should be understood by fast-import.
886
-
887
-Feature work identical as their option counterparts with the
888
-exception of the import-marks feature, see below.
889
-
890
-The following features are currently supported:
891
-
892
-* date-format
893
-* import-marks
894
-* export-marks
895
-* relative-marks
896
-* no-relative-marks
897
-* force
898
-
899
-The import-marks behaves differently from when it is specified as
900
-commandline option in that only one "feature import-marks" is allowed
901
-per stream. Also, any --import-marks= specified on the commandline
902
-will override those from the stream (if any).
884
+The <feature> part of the command may be any one of the following:
885
+
886
+date-format::
887
+export-marks::
888
+relative-marks::
889
+no-relative-marks::
890
+force::
891
+ Act as though the corresponding command-line option with
892
+ a leading '--' was passed on the command line
893
+ (see OPTIONS, above).
894
+
895
+import-marks::
896
+ Like --import-marks except in two respects: first, only one
897
+ "feature import-marks" command is allowed per stream;
898
+ second, an --import-marks= command-line option overrides
899
+ any "feature import-marks" command in the stream.
900
901
`option`
902
~~~~~~~~