mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
Documentation: format full commands in typewriter font
Use `code snippet` style instead of 'emphasis' for `git cmd ...` according to the following rules: * The SYNOPSIS sections are left untouched. * If the intent is that the user type the command exactly as given, it is `code`. If the user is only loosely referred to a command and/or option, it remains 'emphasised'. Signed-off-by: Thomas Rast <trast@student.ethz.ch>
This commit is contained in:
parent
e330d8ca1a
commit
ca768288b6
|
@ -741,15 +741,15 @@ diff.mnemonicprefix::
|
|||
standard "a/" and "b/" depending on what is being compared. When
|
||||
this configuration is in effect, reverse diff output also swaps
|
||||
the order of the prefixes:
|
||||
'git-diff';;
|
||||
`git diff`;;
|
||||
compares the (i)ndex and the (w)ork tree;
|
||||
'git-diff HEAD';;
|
||||
`git diff HEAD`;;
|
||||
compares a (c)ommit and the (w)ork tree;
|
||||
'git diff --cached';;
|
||||
`git diff --cached`;;
|
||||
compares a (c)ommit and the (i)ndex;
|
||||
'git-diff HEAD:file1 file2';;
|
||||
`git diff HEAD:file1 file2`;;
|
||||
compares an (o)bject and a (w)ork tree entity;
|
||||
'git diff --no-index a b';;
|
||||
`git diff --no-index a b`;;
|
||||
compares two non-git things (1) and (2).
|
||||
|
||||
diff.renameLimit::
|
||||
|
@ -1015,7 +1015,7 @@ gui.spellingdictionary::
|
|||
off.
|
||||
|
||||
gui.fastcopyblame::
|
||||
If true, 'git gui blame' uses '-C' instead of '-C -C' for original
|
||||
If true, 'git gui blame' uses `-C` instead of `-C -C` for original
|
||||
location detection. It makes blame significantly faster on huge
|
||||
repositories at the expense of less thorough copy detection.
|
||||
|
||||
|
|
|
@ -39,7 +39,7 @@ 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 'git 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
|
||||
|
|
|
@ -294,7 +294,7 @@ To get a checkout with the Eclipse CVS client:
|
|||
Protocol notes: If you are using anonymous access via pserver, just select that.
|
||||
Those using SSH access should choose the 'ext' protocol, and configure 'ext'
|
||||
access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to
|
||||
"'git cvsserver'". Note that password support is not good when using 'ext',
|
||||
"`git cvsserver`". Note that password support is not good when using 'ext',
|
||||
you will definitely want to have SSH keys setup.
|
||||
|
||||
Alternatively, you can just use the non-standard extssh protocol that Eclipse
|
||||
|
|
|
@ -129,8 +129,8 @@ convenience functions, too. For example, calling 'skip_commit "$@"'
|
|||
will leave out the current commit (but not its changes! If you want
|
||||
that, use 'git-rebase' instead).
|
||||
+
|
||||
You can also use the 'git_commit_non_empty_tree "$@"' instead of
|
||||
'git commit-tree "$@"' if you don't wish to keep commits with a single parent
|
||||
You can also use the `git_commit_non_empty_tree "$@"` instead of
|
||||
`git commit-tree "$@"` if you don't wish to keep commits with a single parent
|
||||
and that makes no change to the tree.
|
||||
|
||||
--tag-name-filter <command>::
|
||||
|
@ -179,7 +179,7 @@ the nearest ancestor that was not excluded.
|
|||
and only one parent, it will hence keep merges points. Also, this
|
||||
option is not compatible with the use of '--commit-filter'. Though you
|
||||
just need to use the function 'git_commit_non_empty_tree "$@"' instead
|
||||
of the 'git commit-tree "$@"' idiom in your commit filter to make that
|
||||
of the `git commit-tree "$@"` idiom in your commit filter to make that
|
||||
happen.
|
||||
|
||||
--original <namespace>::
|
||||
|
|
|
@ -50,7 +50,7 @@ Housekeeping is required if there are too many loose objects or
|
|||
too many packs in the repository. If the number of loose objects
|
||||
exceeds the value of the `gc.auto` configuration variable, then
|
||||
all loose objects are combined into a single pack using
|
||||
'git-repack -d -l'. Setting the value of `gc.auto` to 0
|
||||
`git-repack -d -l`. Setting the value of `gc.auto` to 0
|
||||
disables automatic packing of loose objects.
|
||||
+
|
||||
If the number of packs exceeds the value of `gc.autopacklimit`,
|
||||
|
|
|
@ -28,7 +28,7 @@ in the current working directory. Note that:
|
|||
in a directory 'sub' that has a directory 'dir', you can run 'git
|
||||
ls-tree -r HEAD dir' to list the contents of the tree (that is
|
||||
'sub/dir' in 'HEAD'). You don't want to give a tree that is not at the
|
||||
root level (e.g. 'git ls-tree -r HEAD:sub dir') in this case, as that
|
||||
root level (e.g. `git ls-tree -r HEAD:sub dir`) in this case, as that
|
||||
would result in asking for 'sub/sub/dir' in the 'HEAD' commit.
|
||||
However, the current working directory can be ignored by passing
|
||||
--full-tree option.
|
||||
|
@ -84,7 +84,7 @@ Output Format
|
|||
|
||||
Unless the `-z` option is used, TAB, LF, and backslash characters
|
||||
in pathnames are represented as `\t`, `\n`, and `\\`, respectively.
|
||||
This output format is compatible with what '--index-info --stdin' of
|
||||
This output format is compatible with what `--index-info --stdin` of
|
||||
'git update-index' expects.
|
||||
|
||||
When the `-l` option is used, format changes to
|
||||
|
|
|
@ -193,7 +193,7 @@ After seeing a conflict, you can do two things:
|
|||
|
||||
* Decide not to merge. The only clean-ups you need are to reset
|
||||
the index file to the `HEAD` commit to reverse 2. and to clean
|
||||
up working tree changes made by 2. and 3.; 'git-reset --hard' can
|
||||
up working tree changes made by 2. and 3.; `git-reset --hard` can
|
||||
be used for this.
|
||||
|
||||
* Resolve the conflicts. Git will mark the conflicts in
|
||||
|
@ -202,19 +202,19 @@ After seeing a conflict, you can do two things:
|
|||
|
||||
You can work through the conflict with a number of tools:
|
||||
|
||||
* Use a mergetool. 'git mergetool' to launch a graphical
|
||||
* Use a mergetool. `git mergetool` to launch a graphical
|
||||
mergetool which will work you through the merge.
|
||||
|
||||
* Look at the diffs. 'git diff' will show a three-way diff,
|
||||
* Look at the diffs. `git diff` will show a three-way diff,
|
||||
highlighting changes from both the HEAD and their versions.
|
||||
|
||||
* Look at the diffs on their own. 'git log --merge -p <path>'
|
||||
* Look at the diffs on their own. `git log --merge -p <path>`
|
||||
will show diffs first for the HEAD version and then
|
||||
their version.
|
||||
|
||||
* Look at the originals. 'git show :1:filename' shows the
|
||||
common ancestor, 'git show :2:filename' shows the HEAD
|
||||
version and 'git show :3:filename' shows their version.
|
||||
* Look at the originals. `git show :1:filename` shows the
|
||||
common ancestor, `git show :2:filename` shows the HEAD
|
||||
version and `git show :3:filename` shows their version.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
|
|
|
@ -65,7 +65,7 @@ OPTIONS
|
|||
BUGS
|
||||
----
|
||||
Comparing blobs or trees that have been replaced with those that
|
||||
replace them will not work properly. And using 'git reset --hard' to
|
||||
replace them will not work properly. And using `git reset --hard` to
|
||||
go back to a replaced commit will move the branch to the replacement
|
||||
commit instead of the replaced commit.
|
||||
|
||||
|
|
|
@ -20,8 +20,8 @@ effect of an earlier commit (often a faulty one). If you want to
|
|||
throw away all uncommitted changes in your working directory, you
|
||||
should see linkgit:git-reset[1], particularly the '--hard' option. If
|
||||
you want to extract specific files as they were in another commit, you
|
||||
should see linkgit:git-checkout[1], specifically the 'git checkout
|
||||
<commit> -- <filename>' syntax. Take care with these alternatives as
|
||||
should see linkgit:git-checkout[1], specifically the `git checkout
|
||||
<commit> -- <filename>` syntax. Take care with these alternatives as
|
||||
both will discard uncommitted changes in your working directory.
|
||||
|
||||
OPTIONS
|
||||
|
|
|
@ -20,7 +20,7 @@ SYNOPSIS
|
|||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
Use 'git stash' when you want to record the current state of the
|
||||
Use `git stash` when you want to record the current state of the
|
||||
working directory and the index, but want to go back to a clean
|
||||
working directory. The command saves your local modifications away
|
||||
and reverts the working directory to match the `HEAD` commit.
|
||||
|
|
|
@ -114,8 +114,8 @@ init::
|
|||
The key used in .git/config is `submodule.$name.url`.
|
||||
This command does not alter existing information in .git/config.
|
||||
You can then customize the submodule clone URLs in .git/config
|
||||
for your local setup and proceed to 'git submodule update';
|
||||
you can also just use 'git submodule update --init' without
|
||||
for your local setup and proceed to `git submodule update`;
|
||||
you can also just use `git submodule update --init` without
|
||||
the explicit 'init' step if you do not intend to customize
|
||||
any submodule locations.
|
||||
|
||||
|
|
|
@ -20,7 +20,7 @@ OPTIONS
|
|||
Cause the logical variables to be listed. In addition, all the
|
||||
variables of the git configuration file .git/config are listed
|
||||
as well. (However, the configuration variables listing functionality
|
||||
is deprecated in favor of 'git config -l'.)
|
||||
is deprecated in favor of `git config -l`.)
|
||||
|
||||
EXAMPLE
|
||||
--------
|
||||
|
|
Loading…
Reference in a new issue