Documentation: use "command-line" when used as a compound adjective, and fix other minor grammatical issues
Signed-off-by: Jason St. John <jstjohn@purdue.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jason St. John committed
May 21, 2014 at 14:52 UTC
06ab60c06606613f238f3154cb27cb22d9723967
19 files changed
+47
-47
Documentation/config.txt
+5
-5
@@ -381,7 +381,7 @@ false), while all other repositories are assumed to be bare (bare
381
core.worktree::
382
Set the path to the root of the working tree.
383
This can be overridden by the GIT_WORK_TREE environment
384
- variable and the '--work-tree' command line option.
384
+ variable and the '--work-tree' command-line option.
385
The value can be an absolute path or relative to the path to
386
the .git directory, which is either specified by --git-dir
387
or GIT_DIR, or automatically discovered.
@@ -523,7 +523,7 @@ core.askpass::
523
environment variable. If not set, fall back to the value of the
524
'SSH_ASKPASS' environment variable or, failing that, a simple password
525
prompt. The external program shall be given a suitable prompt as
526
- command line argument and write the password on its STDOUT.
526
+ command-line argument and write the password on its STDOUT.
527
528
core.attributesfile::
529
In addition to '.gitattributes' (per-directory) and
@@ -1324,7 +1324,7 @@ grep.extendedRegexp::
1324
gpg.program::
1325
Use this custom program instead of "gpg" found on $PATH when
1326
making or verifying a PGP signature. The program must support the
1327
- same command line interface as GPG, namely, to verify a detached
1327
+ same command-line interface as GPG, namely, to verify a detached
1328
signature, "gpg --verify $file - <$signature" is run, and the
1329
program is expected to signal a good signature by exiting with
1330
code 0, and to generate an ascii-armored detached signature, the
@@ -2295,7 +2295,7 @@ status.submodulesummary::
2295
submodules when `diff.ignoreSubmodules` is set to 'all' or only
2296
for those submodules where `submodule.<name>.ignore=all`. To
2297
also view the summary for ignored submodules you can either use
2298
- the --ignore-submodules=dirty command line option or the 'git
2298
+ the --ignore-submodules=dirty command-line option or the 'git
2299
submodule summary' command, which shows a similar output but does
2300
not honor these settings.
2301
@@ -2317,7 +2317,7 @@ submodule.<name>.branch::
2317
submodule.<name>.fetchRecurseSubmodules::
2318
This option can be used to control recursive fetching of this
2319
submodule. It can be overridden by using the --[no-]recurse-submodules
2320
- command line option to "git fetch" and "git pull".
2320
+ command-line option to "git fetch" and "git pull".
2321
This setting will override that from in the linkgit:gitmodules[5]
2322
file.
2323
Documentation/diff-config.txt
+1
-1
@@ -76,7 +76,7 @@ diff.ignoreSubmodules::
76
this setting when reporting uncommitted changes. Setting it to
77
'all' disables the submodule summary normally shown by 'git commit'
78
and 'git status' when 'status.submodulesummary' is set unless it is
79
- overridden by using the --ignore-submodules command line option.
79
+ overridden by using the --ignore-submodules command-line option.
80
The 'git submodule' commands are not affected by this setting.
81
82
diff.mnemonicprefix::
Documentation/git-bisect.txt
+1
-1
@@ -117,7 +117,7 @@ $ git bisect visualize
117
`view` may also be used as a synonym for `visualize`.
118
119
If the 'DISPLAY' environment variable is not set, 'git log' is used
120
-instead. You can also give command line options such as `-p` and
120
+instead. You can also give command-line options such as `-p` and
121
`--stat`.
122
123
------------
Documentation/git-config.txt
+1
-1
@@ -256,7 +256,7 @@ All writing options will per default write to the repository specific
256
configuration file. Note that this also affects options like '--replace-all'
257
and '--unset'. *'git config' will only ever change one file at a time*.
258
259
-You can override these rules either by command line options or by environment
259
+You can override these rules either by command-line options or by environment
260
variables. The '--global' and the '--system' options will limit the file used
261
to the global or system-wide file respectively. The GIT_CONFIG environment
262
variable has a similar effect, but you can specify any filename you want.
Documentation/git-daemon.txt
+3
-3
@@ -169,7 +169,7 @@ Git configuration files in that directory are readable by `<user>`.
169
--forbid-override=<service>::
170
Allow/forbid overriding the site-wide default with per
171
repository configuration. By default, all the services
172
- are overridable.
172
+ may be overridden.
173
174
--[no-]informative-errors::
175
When informative errors are turned on, git-daemon will report
@@ -184,7 +184,7 @@ Git configuration files in that directory are readable by `<user>`.
184
Every time a client connects, first run an external command
185
specified by the <path> with service name (e.g. "upload-pack"),
186
path to the repository, hostname (%H), canonical hostname
187
- (%CH), ip address (%IP), and tcp port (%P) as its command line
187
+ (%CH), IP address (%IP), and TCP port (%P) as its command-line
188
arguments. The external command can decide to decline the
189
service by exiting with a non-zero status (or to allow it by
190
exiting with a zero status). It can also look at the $REMOTE_ADDR
@@ -204,7 +204,7 @@ SERVICES
204
--------
205
206
These services can be globally enabled/disabled using the
207
-command line options of this command. If a finer-grained
207
+command-line options of this command. If finer-grained
208
control is desired (e.g. to allow 'git archive' to be run
209
against only in a few selected repositories the daemon serves),
210
the per-repository configuration file can be used to enable or
Documentation/git-fast-import.txt
+5
-5
@@ -231,7 +231,7 @@ Date Formats
231
~~~~~~~~~~~~
232
The following date formats are supported. A frontend should select
233
the format it will use for this import by passing the format name
234
-in the \--date-format=<fmt> command line option.
234
+in the \--date-format=<fmt> command-line option.
235
236
`raw`::
237
This is the Git native format and is `<time> SP <offutc>`.
@@ -348,7 +348,7 @@ and control the current import process. More detailed discussion
348
`done`::
349
Marks the end of the stream. This command is optional
350
unless the `done` feature was requested using the
351
- `--done` command line option or `feature done` command.
351
+ `--done` command-line option or `feature done` command.
352
353
`cat-blob`::
354
Causes fast-import to print a blob in 'cat-file --batch'
@@ -437,7 +437,7 @@ the email address from the other fields in the line. Note that
437
of bytes, except `LT`, `GT` and `LF`. `<name>` is typically UTF-8 encoded.
438
439
The time of the change is specified by `<when>` using the date format
440
-that was selected by the \--date-format=<fmt> command line option.
440
+that was selected by the \--date-format=<fmt> command-line option.
441
See ``Date Formats'' above for the set of supported formats, and
442
their syntax.
443
@@ -1085,7 +1085,7 @@ Option commands must be the first commands on the input (not counting
1085
feature commands), to give an option command after any non-option
1086
command is an error.
1087
1088
-The following commandline options change import semantics and may therefore
1088
+The following command-line options change import semantics and may therefore
1089
not be passed as option:
1090
1091
* date-format
@@ -1099,7 +1099,7 @@ not be passed as option:
1099
If the `done` feature is not in use, treated as if EOF was read.
1100
This can be used to tell fast-import to finish early.
1101
1102
-If the `--done` command line option or `feature done` command is
1102
+If the `--done` command-line option or `feature done` command is
1103
in use, the `done` command is mandatory and marks the end of the
1104
stream.
1105
Documentation/git-help.txt
+6
-6
@@ -80,9 +80,9 @@ CONFIGURATION VARIABLES
80
help.format
81
~~~~~~~~~~~
82
83
-If no command line option is passed, the 'help.format' configuration
83
+If no command-line option is passed, the 'help.format' configuration
84
variable will be checked. The following values are supported for this
85
-variable; they make 'git help' behave as their corresponding command
85
+variable; they make 'git help' behave as their corresponding command-
86
line option:
87
88
* "man" corresponds to '-m|--man',
@@ -93,15 +93,15 @@ help.browser, web.browser and browser.<tool>.path
93
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94
95
The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
96
-be checked if the 'web' format is chosen (either by command line
96
+be checked if the 'web' format is chosen (either by command-line
97
option or configuration variable). See '-w|--web' in the OPTIONS
98
section above and linkgit:git-web{litdd}browse[1].
99
100
man.viewer
101
~~~~~~~~~~
102
103
-The 'man.viewer' config variable will be checked if the 'man' format
104
-is chosen. The following values are currently supported:
103
+The 'man.viewer' configuration variable will be checked if the 'man'
104
+format is chosen. The following values are currently supported:
105
106
* "man": use the 'man' program as usual,
107
* "woman": use 'emacsclient' to launch the "woman" mode in emacs
@@ -124,7 +124,7 @@ For example, this configuration:
124
viewer = woman
125
------------------------------------------------
126
127
-will try to use konqueror first. But this may fail (for example if
127
+will try to use konqueror first. But this may fail (for example, if
128
DISPLAY is not set) and in that case emacs' woman mode will be tried.
129
130
If everything fails, or if no viewer is configured, the viewer specified
Documentation/git-ls-files.txt
+3
-3
@@ -185,15 +185,15 @@ specifies the format of exclude patterns.
185
186
These exclude patterns come from these places, in order:
187
188
- 1. The command line flag --exclude=<pattern> specifies a
188
+ 1. The command-line flag --exclude=<pattern> specifies a
189
single pattern. Patterns are ordered in the same order
190
they appear in the command line.
191
192
- 2. The command line flag --exclude-from=<file> specifies a
192
+ 2. The command-line flag --exclude-from=<file> specifies a
193
file containing a list of patterns. Patterns are ordered
194
in the same order they appear in the file.
195
196
- 3. The command line flag --exclude-per-directory=<name> specifies
196
+ 3. The command-line flag --exclude-per-directory=<name> specifies
197
a name of the file in each directory 'git ls-files'
198
examines, normally `.gitignore`. Files in deeper
199
directories take precedence. Patterns are ordered in the
Documentation/git-read-tree.txt
+1
-1
@@ -283,7 +283,7 @@ merge. The different stages represent the "result tree" (stage 0, aka
283
you are trying to merge (stage 2 and 3 respectively).
284
285
The order of stages 1, 2 and 3 (hence the order of three
286
-<tree-ish> command line arguments) are significant when you
286
+<tree-ish> command-line arguments) are significant when you
287
start a 3-way merge with an index file that is already
288
populated. Here is an outline of how the algorithm works:
289
Documentation/git-send-email.txt
+3
-3
@@ -20,7 +20,7 @@ files in the directory), or directly as a revision list. In the
20
last case, any format accepted by linkgit:git-format-patch[1] can
21
be passed to git send-email.
22
23
-The header of the email is configurable by command line options. If not
23
+The header of the email is configurable via command-line options. If not
24
specified on the command line, the user will be prompted with a ReadLine
25
enabled interface to provide the necessary information.
26
@@ -68,7 +68,7 @@ The --cc option must be repeated for each user you want on the cc list.
68
When '--compose' is used, git send-email will use the From, Subject, and
69
In-Reply-To headers specified in the message. If the body of the message
70
(what you type after the headers and a blank line) only contains blank
71
-(or Git: prefixed) lines the summary won't be sent, but From, Subject,
71
+(or Git: prefixed) lines, the summary won't be sent, but From, Subject,
72
and In-Reply-To headers will be used unless they are removed.
73
+
74
Missing From or In-Reply-To headers will be prompted for.
@@ -78,7 +78,7 @@ See the CONFIGURATION section for 'sendemail.multiedit'.
78
--from=<address>::
79
Specify the sender of the emails. If not specified on the command line,
80
the value of the 'sendemail.from' configuration option is used. If
81
- neither the command line option nor 'sendemail.from' are set, then the
81
+ neither the command-line option nor 'sendemail.from' are set, then the
82
user will be prompted for the value. The default for the prompt will be
83
the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
84
set, as returned by "git var -l".
Documentation/git-svn.txt
+2
-2
@@ -148,8 +148,8 @@ the same local time zone.
148
[verse]
149
config key: svn-remote.<name>.ignore-paths
150
+
151
-If the ignore-paths config key is set and the command line option is
152
-also given, both regular expressions will be used.
151
+If the ignore-paths configuration key is set, and the command-line
152
+option is also given, both regular expressions will be used.
153
+
154
Examples:
155
+
Documentation/git-web--browse.txt
+2
-2
@@ -62,7 +62,7 @@ CONF.VAR (from -c option) and web.browser
62
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
63
64
The web browser can be specified using a configuration variable passed
65
-with the -c (or --config) command line option, or the 'web.browser'
65
+with the -c (or --config) command-line option, or the 'web.browser'
66
configuration variable if the former is not used.
67
68
browser.<tool>.path
@@ -87,7 +87,7 @@ the URLs passed as arguments.
87
Note about konqueror
88
--------------------
89
90
-When 'konqueror' is specified by a command line option or a
90
+When 'konqueror' is specified by a command-line option or a
91
configuration variable, we launch 'kfmclient' to try to open the HTML
92
man page on an already opened konqueror in a new tab if possible.
93
Documentation/git.txt
+4
-4
@@ -29,7 +29,7 @@ in-depth introduction.
29
After you mastered the basic concepts, you can come back to this
30
page to learn what commands Git offers. You can learn more about
31
individual Git commands with "git help command". linkgit:gitcli[7]
32
-manual page gives you an overview of the command line command syntax.
32
+manual page gives you an overview of the command-line command syntax.
33
34
Formatted and hyperlinked version of the latest Git documentation
35
can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.
@@ -39,7 +39,7 @@ ifdef::stalenotes[]
39
============
40
41
You are reading the documentation for the latest (possibly
42
-unreleased) version of Git, that is available from 'master'
42
+unreleased) version of Git, that is available from the 'master'
43
branch of the `git.git` repository.
44
Documentation for older releases are available here:
45
@@ -749,7 +749,7 @@ Git so take care if using Cogito etc.
749
750
'GIT_WORK_TREE'::
751
Set the path to the root of the working tree.
752
- This can also be controlled by the '--work-tree' command line
752
+ This can also be controlled by the '--work-tree' command-line
753
option and the core.worktree configuration variable.
754
755
'GIT_NAMESPACE'::
@@ -874,7 +874,7 @@ for further details.
874
'GIT_ASKPASS'::
875
If this environment variable is set, then Git commands which need to
876
acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
877
- will call this program with a suitable prompt as command line argument
877
+ will call this program with a suitable prompt as command-line argument
878
and read the password from its STDOUT. See also the 'core.askpass'
879
option in linkgit:git-config[1].
880
Documentation/gitcli.txt
+4
-4
@@ -3,7 +3,7 @@ gitcli(7)
3
4
NAME
5
----
6
-gitcli - Git command line interface and conventions
6
+gitcli - Git command-line interface and conventions
7
8
SYNOPSIS
9
--------
@@ -66,13 +66,13 @@ you will.
66
Here are the rules regarding the "flags" that you should follow when you are
67
scripting Git:
68
69
- * it's preferred to use the non dashed form of Git commands, which means that
69
+ * it's preferred to use the non-dashed form of Git commands, which means that
70
you should prefer `git foo` to `git-foo`.
71
72
* splitting short options to separate words (prefer `git foo -a -b`
73
to `git foo -ab`, the latter may not even work).
74
75
- * when a command line option takes an argument, use the 'stuck' form. In
75
+ * when a command-line option takes an argument, use the 'stuck' form. In
76
other words, write `git foo -oArg` instead of `git foo -o Arg` for short
77
options, and `git foo --long-opt=Arg` instead of `git foo --long-opt Arg`
78
for long options. An option that takes optional option-argument must be
@@ -103,7 +103,7 @@ Here is a list of the facilities provided by this option parser.
103
Magic Options
104
~~~~~~~~~~~~~
105
Commands which have the enhanced option parser activated all understand a
106
-couple of magic command line options:
106
+couple of magic command-line options:
107
108
-h::
109
gives a pretty printed usage of the command.
Documentation/gitk.txt
+1
-1
@@ -27,7 +27,7 @@ gitk-specific options.
27
28
gitk generally only understands options with arguments in the
29
'sticked' form (see linkgit:gitcli[7]) due to limitations in the
30
-command line parser.
30
+command-line parser.
31
32
rev-list options and arguments
33
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Documentation/gitweb.conf.txt
+1
-1
@@ -904,7 +904,7 @@ the following in your GITWEB_CONFIG file:
904
$feature{'snapshot'}{'override'} = 1;
905
906
If you allow overriding for the snapshot feature, you can specify which
907
-snapshot formats are globally disabled. You can also add any command line
907
+snapshot formats are globally disabled. You can also add any command-line
908
options you want (such as setting the compression level). For instance, you
909
can disable Zip compressed snapshots and set *gzip*(1) to run at level 6 by
910
adding the following lines to your gitweb configuration file:
Documentation/howto/setup-git-server-over-http.txt
+1
-1
@@ -181,7 +181,7 @@ On Debian:
181
182
Most tests should pass.
183
184
-A command line tool to test WebDAV is cadaver. If you prefer GUIs, for
184
+A command-line tool to test WebDAV is cadaver. If you prefer GUIs, for
185
example, konqueror can open WebDAV URLs as "webdav://..." or
186
"webdavs://...".
187
Documentation/technical/http-protocol.txt
+1
-1
@@ -374,7 +374,7 @@ C: Send one `$GIT_URL/git-upload-pack` request:
374
C: 0000
375
376
The stream is organized into "commands", with each command
377
-appearing by itself in a pkt-line. Within a command line
377
+appearing by itself in a pkt-line. Within a command line,
378
the text leading up to the first space is the command name,
379
and the remainder of the line to the first LF is the value.
380
Command lines are terminated with an LF as the last byte of
Documentation/user-manual.txt
+2
-2
@@ -4231,9 +4231,9 @@ Most of what `git rev-list` did is contained in `revision.c` and
4231
controls how and what revisions are walked, and more.
4232
4233
The original job of `git rev-parse` is now taken by the function
4234
-`setup_revisions()`, which parses the revisions and the common command line
4234
+`setup_revisions()`, which parses the revisions and the common command-line
4235
options for the revision walker. This information is stored in the struct
4236
-`rev_info` for later consumption. You can do your own command line option
4236
+`rev_info` for later consumption. You can do your own command-line option
4237
parsing after calling `setup_revisions()`. After that, you have to call
4238
`prepare_revision_walk()` for initialization, and then you can get the
4239
commits one by one with the function `get_revision()`.