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