Browse Source

git-add/rm doc: Consistently back-quote

Consistently back-quote commands, options and file names.

Signed-off-by: Björn Gustavsson <bgustavsson@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Björn Gustavsson 15 years ago committed by Junio C Hamano
parent
commit
441947f6d7
  1. 24
      Documentation/git-add.txt
  2. 6
      Documentation/git-rm.txt

24
Documentation/git-add.txt

@ -24,22 +24,22 @@ remove paths that do not exist in the working tree anymore. @@ -24,22 +24,22 @@ remove paths that do not exist in the working tree anymore.
The "index" holds a snapshot of the content of the working tree, and it
is this snapshot that is taken as the contents of the next commit. Thus
after making any changes to the working directory, and before running
the commit command, you must use the 'add' command to add any new or
the commit command, you must use the `add` command to add any new or
modified files to the index.

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

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

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

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

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

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

You also could say "s" or "sta" or "status" above as long as the
You also could say `s` or `sta` or `status` above as long as the
choice is unique.

The main command loop has 6 subcommands (plus help and quit).
@ -196,9 +196,9 @@ The main command loop has 6 subcommands (plus help and quit). @@ -196,9 +196,9 @@ The main command loop has 6 subcommands (plus help and quit).
status::

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

6
Documentation/git-rm.txt

@ -12,13 +12,13 @@ SYNOPSIS @@ -12,13 +12,13 @@ SYNOPSIS
DESCRIPTION
-----------
Remove files from the index, or from the working tree and the index.
'git-rm' will not remove a file from just your working directory.
`git rm` will not remove a file from just your working directory.
(There is no option to remove a file only from the work tree
and yet keep it in the index; use `/bin/rm` if you want to do that.)
The files being removed have to be identical to the tip of the branch,
and no updates to their contents can be staged in the index,
though that default behavior can be overridden with the `-f` option.
When '--cached' is given, the staged content has to
When `--cached` is given, the staged content has to
match either the tip of the branch or the file on disk,
allowing the file to be removed from just the index.

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

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



Loading…
Cancel
Save