Skip to content

Commit 441947f

Browse files
bjornggitster
authored andcommitted
git-add/rm doc: Consistently back-quote
Consistently back-quote commands, options and file names. Signed-off-by: Björn Gustavsson <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 968d707 commit 441947f

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

Documentation/git-add.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,22 @@ remove paths that do not exist in the working tree anymore.
2424
The "index" holds a snapshot of the content of the working tree, and it
2525
is this snapshot that is taken as the contents of the next commit. Thus
2626
after making any changes to the working directory, and before running
27-
the commit command, you must use the 'add' command to add any new or
27+
the commit command, you must use the `add` command to add any new or
2828
modified files to the index.
2929

3030
This command can be performed multiple times before a commit. It only
3131
adds the content of the specified file(s) at the time the add command is
3232
run; if you want subsequent changes included in the next commit, then
33-
you must run 'git add' again to add the new content to the index.
33+
you must run `git add` again to add the new content to the index.
3434

35-
The 'git status' command can be used to obtain a summary of which
35+
The `git status` command can be used to obtain a summary of which
3636
files have changes that are staged for the next commit.
3737

38-
The 'git add' command will not add ignored files by default. If any
39-
ignored files were explicitly specified on the command line, 'git add'
38+
The `git add` command will not add ignored files by default. If any
39+
ignored files were explicitly specified on the command line, `git add`
4040
will fail with a list of ignored files. Ignored files reached by
4141
directory recursion or filename globbing performed by Git (quote your
42-
globs before the shell) will be silently ignored. The 'add' command can
42+
globs before the shell) will be silently ignored. The `add` command can
4343
be used to add ignored files with the `-f` (force) option.
4444

4545
Please see linkgit:git-commit[1] for alternative ways to add content to a
@@ -119,8 +119,8 @@ subdirectories.
119119
Record only the fact that the path will be added later. An entry
120120
for the path is placed in the index with no content. This is
121121
useful for, among other things, showing the unstaged content of
122-
such files with 'git diff' and committing them with 'git commit
123-
-a'.
122+
such files with `git diff` and committing them with `git commit
123+
-a`.
124124

125125
--refresh::
126126
Don't add the file(s), but only refresh their stat()
@@ -140,7 +140,7 @@ subdirectories.
140140
Configuration
141141
-------------
142142

143-
The optional configuration variable 'core.excludesfile' indicates a path to a
143+
The optional configuration variable `core.excludesfile` indicates a path to a
144144
file containing patterns of file names to exclude from git-add, similar to
145145
$GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to
146146
those in info/exclude. See linkgit:gitrepository-layout[5].
@@ -188,17 +188,17 @@ and type return, like this:
188188
What now> 1
189189
------------
190190

191-
You also could say "s" or "sta" or "status" above as long as the
191+
You also could say `s` or `sta` or `status` above as long as the
192192
choice is unique.
193193

194194
The main command loop has 6 subcommands (plus help and quit).
195195

196196
status::
197197

198198
This shows the change between HEAD and index (i.e. what will be
199-
committed if you say "git commit"), and between index and
199+
committed if you say `git commit`), and between index and
200200
working tree files (i.e. what you could stage further before
201-
"git commit" using "git-add") for each path. A sample output
201+
`git commit` using `git add`) for each path. A sample output
202202
looks like this:
203203
+
204204
------------

Documentation/git-rm.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ SYNOPSIS
1212
DESCRIPTION
1313
-----------
1414
Remove files from the index, or from the working tree and the index.
15-
'git-rm' will not remove a file from just your working directory.
15+
`git rm` will not remove a file from just your working directory.
1616
(There is no option to remove a file only from the work tree
1717
and yet keep it in the index; use `/bin/rm` if you want to do that.)
1818
The files being removed have to be identical to the tip of the branch,
1919
and no updates to their contents can be staged in the index,
2020
though that default behavior can be overridden with the `-f` option.
21-
When '--cached' is given, the staged content has to
21+
When `--cached` is given, the staged content has to
2222
match either the tip of the branch or the file on disk,
2323
allowing the file to be removed from just the index.
2424

@@ -64,7 +64,7 @@ OPTIONS
6464

6565
-q::
6666
--quiet::
67-
'git-rm' normally outputs one line (in the form of an "rm" command)
67+
`git rm` normally outputs one line (in the form of an `rm` command)
6868
for each file removed. This option suppresses that output.
6969

7070

0 commit comments

Comments
 (0)