@@ -19,6 +19,15 @@ Many commands take revisions (most often "commits", but sometimes
19
19
"tree-ish", depending on the context and command) and paths as their
20
20
arguments. Here are the rules:
21
21
22
+ * Options come first and then args.
23
+ A subcommand may take dashed options (which may take their own
24
+ arguments, e.g. "--max-parents 2") and arguments. You SHOULD
25
+ give dashed options first and then arguments. Some commands may
26
+ accept dashed options after you have already gave non-option
27
+ arguments (which may make the command ambiguous), but you should
28
+ not rely on it (because eventually we may find a way to fix
29
+ these ambiguity by enforcing the "options then args" rule).
30
+
22
31
* Revisions come first and then paths.
23
32
E.g. in `git diff v1.0 v2.0 arch/x86 include/asm-x86`,
24
33
`v1.0` and `v2.0` are revisions and `arch/x86` and `include/asm-x86`
@@ -72,24 +81,24 @@ you will.
72
81
Here are the rules regarding the "flags" that you should follow when you are
73
82
scripting Git:
74
83
75
- * it 's preferred to use the non-dashed form of Git commands, which means that
84
+ * It 's preferred to use the non-dashed form of Git commands, which means that
76
85
you should prefer `git foo` to `git-foo`.
77
86
78
- * splitting short options to separate words (prefer `git foo -a -b`
87
+ * Splitting short options to separate words (prefer `git foo -a -b`
79
88
to `git foo -ab`, the latter may not even work).
80
89
81
- * when a command-line option takes an argument, use the 'stuck' form. In
90
+ * When a command-line option takes an argument, use the 'stuck' form. In
82
91
other words, write `git foo -oArg` instead of `git foo -o Arg` for short
83
92
options, and `git foo --long-opt=Arg` instead of `git foo --long-opt Arg`
84
93
for long options. An option that takes optional option-argument must be
85
94
written in the 'stuck' form.
86
95
87
- * when you give a revision parameter to a command, make sure the parameter is
96
+ * When you give a revision parameter to a command, make sure the parameter is
88
97
not ambiguous with a name of a file in the work tree. E.g. do not write
89
98
`git log -1 HEAD` but write `git log -1 HEAD --`; the former will not work
90
99
if you happen to have a file called `HEAD` in the work tree.
91
100
92
- * many commands allow a long option `--option` to be abbreviated
101
+ * Many commands allow a long option `--option` to be abbreviated
93
102
only to their unique prefix (e.g. if there is no other option
94
103
whose name begins with `opt`, you may be able to spell `--opt` to
95
104
invoke the `--option` flag), but you should fully spell them out
0 commit comments