undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

revisions.txt: consistent use of quotes

Browse Source 
Our use of quotes is inconsistent everywhere and within some files.
Before reworking the structure of revisions.txt, make the quotes
consistent:

`git command`

'some snippet or term'

The former gets typeset as code, the latter with some form of emphasis.
the man backend uses two types of emphasis.

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Michael J Gruber 2011-04-01 11:27:40 +02:00 committed by Junio C Hamano
parent 6acef04358
commit 83456b1352
1 changed files with 52 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
Documentation/revisions.txt
View File

@ -13,45 +13,45 @@ blobs contained in a commit.
name the same commit object if there are no other object in name the same commit object if there are no other object in
your repository whose object name starts with dae86e. your repository whose object name starts with dae86e.
* An output from 'git describe'; i.e. a closest tag, optionally * An output from `git describe`; i.e. a closest tag, optionally
followed by a dash and a number of commits, followed by a dash, a followed by a dash and a number of commits, followed by a dash, a
`g`, and an abbreviated object name. 'g', and an abbreviated object name.
* A symbolic ref name. E.g. 'master' typically means the commit * A symbolic ref name. E.g. 'master' typically means the commit
object referenced by refs/heads/master. If you object referenced by 'refs/heads/master'. If you
happen to have both heads/master and tags/master, you can happen to have both 'heads/master' and 'tags/master', you can
explicitly say 'heads/master' to tell git which one you mean. explicitly say 'heads/master' to tell git which one you mean.
When ambiguous, a `<name>` is disambiguated by taking the When ambiguous, a '<name>' is disambiguated by taking the
first match in the following rules: first match in the following rules:
. if `$GIT_DIR/<name>` exists, that is what you mean (this is usually . if '$GIT_DIR/<name>' exists, that is what you mean (this is usually
useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD` useful only for 'HEAD', 'FETCH_HEAD', 'ORIG_HEAD', 'MERGE_HEAD'
and `CHERRY_PICK_HEAD`); and 'CHERRY_PICK_HEAD');
. otherwise, `refs/<name>` if exists; . otherwise, 'refs/<name>' if exists;
. otherwise, `refs/tags/<name>` if exists; . otherwise, 'refs/tags/<name>' if exists;
. otherwise, `refs/heads/<name>` if exists; . otherwise, 'refs/heads/<name>' if exists;
. otherwise, `refs/remotes/<name>` if exists; . otherwise, 'refs/remotes/<name>' if exists;
. otherwise, `refs/remotes/<name>/HEAD` if exists. . otherwise, 'refs/remotes/<name>/HEAD' if exists.
+ +
HEAD names the commit your changes in the working tree is based on. 'HEAD' names the commit your changes in the working tree is based on.
FETCH_HEAD records the branch you fetched from a remote repository 'FETCH_HEAD' records the branch you fetched from a remote repository
with your last 'git fetch' invocation. with your last `git fetch` invocation.
ORIG_HEAD is created by commands that moves your HEAD in a drastic 'ORIG_HEAD' is created by commands that moves your 'HEAD' in a drastic
way, to record the position of the HEAD before their operation, so that way, to record the position of the 'HEAD' before their operation, so that
you can change the tip of the branch back to the state before you ran you can change the tip of the branch back to the state before you ran
them easily. them easily.
MERGE_HEAD records the commit(s) you are merging into your branch 'MERGE_HEAD' records the commit(s) you are merging into your branch
when you run 'git merge'. when you run `git merge`.
CHERRY_PICK_HEAD records the commit you are cherry-picking 'CHERRY_PICK_HEAD' records the commit you are cherry-picking
when you run 'git cherry-pick'. when you run `git cherry-pick`.
+ +
Note that any of the `refs/*` cases above may come either from Note that any of the 'refs/*' cases above may come either from
the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file. the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
* A ref followed by the suffix '@' with a date specification * A ref followed by the suffix '@' with a date specification
enclosed in a brace enclosed in a brace
@ -59,10 +59,10 @@ the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.
second ago\}' or '\{1979-02-26 18:30:00\}') to specify the value second ago\}' or '\{1979-02-26 18:30:00\}') to specify the value
of the ref at a prior point in time. This suffix may only be of the ref at a prior point in time. This suffix may only be
used immediately following a ref name and the ref must have an used immediately following a ref name and the ref must have an
existing log ($GIT_DIR/logs/<ref>). Note that this looks up the state existing log ('$GIT_DIR/logs/<ref>'). Note that this looks up the state
of your *local* ref at a given time; e.g., what was in your local of your *local* ref at a given time; e.g., what was in your local
`master` branch last week. If you want to look at commits made during 'master' branch last week. If you want to look at commits made during
certain times, see `--since` and `--until`. certain times, see '--since' and '--until'.
* A ref followed by the suffix '@' with an ordinal specification * A ref followed by the suffix '@' with an ordinal specification
enclosed in a brace pair (e.g. '\{1\}', '\{15\}') to specify enclosed in a brace pair (e.g. '\{1\}', '\{15\}') to specify
@ -70,7 +70,7 @@ the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.
is the immediate prior value of 'master' while 'master@\{5\}' is the immediate prior value of 'master' while 'master@\{5\}'
is the 5th prior value of 'master'. This suffix may only be used is the 5th prior value of 'master'. This suffix may only be used
immediately following a ref name and the ref must have an existing immediately following a ref name and the ref must have an existing
log ($GIT_DIR/logs/<ref>). log ('$GIT_DIR/logs/<ref>').
* You can use the '@' construct with an empty ref part to get at a * You can use the '@' construct with an empty ref part to get at a
reflog of the current branch. For example, if you are on the reflog of the current branch. For example, if you are on the
@ -98,36 +98,36 @@ the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.
the usage of this form. the usage of this form.
* A suffix '{caret}' followed by an object type name enclosed in * A suffix '{caret}' followed by an object type name enclosed in
brace pair (e.g. `v0.99.8{caret}\{commit\}`) means the object brace pair (e.g. 'v0.99.8{caret}\{commit\}') means the object
could be a tag, and dereference the tag recursively until an could be a tag, and dereference the tag recursively until an
object of that type is found or the object cannot be object of that type is found or the object cannot be
dereferenced anymore (in which case, barf). `rev{caret}0` dereferenced anymore (in which case, barf). 'rev{caret}0'
introduced earlier is a short-hand for `rev{caret}\{commit\}`. introduced earlier is a short-hand for 'rev{caret}\{commit\}'.
* A suffix '{caret}' followed by an empty brace pair * A suffix '{caret}' followed by an empty brace pair
(e.g. `v0.99.8{caret}\{\}`) means the object could be a tag, (e.g. 'v0.99.8{caret}\{\}') means the object could be a tag,
and dereference the tag recursively until a non-tag object is and dereference the tag recursively until a non-tag object is
found. found.
* A suffix '{caret}' to a revision parameter followed by a brace * A suffix '{caret}' to a revision parameter followed by a brace
pair that contains a text led by a slash (e.g. `HEAD^{/fix nasty bug}`): pair that contains a text led by a slash (e.g. 'HEAD^{/fix nasty bug}'):
this is the same as `:/fix nasty bug` syntax below except that this is the same as ':/fix nasty bug' syntax below except that
it returns the youngest matching commit which is reachable from it returns the youngest matching commit which is reachable from
the ref before '{caret}'. the ref before '{caret}'.
* A colon, followed by a slash, followed by a text (e.g. `:/fix nasty bug`): this names * A colon, followed by a slash, followed by a text (e.g. ':/fix nasty bug'): this names
a commit whose commit message matches the specified regular expression. a commit whose commit message matches the specified regular expression.
This name returns the youngest matching commit which is This name returns the youngest matching commit which is
reachable from any ref. If the commit message starts with a reachable from any ref. If the commit message starts with a
'!', you have to repeat that; the special sequence ':/!', '!', you have to repeat that; the special sequence ':/!',
followed by something else than '!' is reserved for now. followed by something else than '!' is reserved for now.
The regular expression can match any part of the commit message. To The regular expression can match any part of the commit message. To
match messages starting with a string, one can use e.g. `:/^foo`. match messages starting with a string, one can use e.g. ':/^foo'.
* A suffix ':' followed by a path (e.g. `HEAD:README`); this names the blob or tree * A suffix ':' followed by a path (e.g. 'HEAD:README'); this names the blob or tree
at the given path in the tree-ish object named by the part at the given path in the tree-ish object named by the part
before the colon. before the colon.
':path' (with an empty part before the colon, e.g. `:README`) ':path' (with an empty part before the colon, e.g. ':README')
is a special case of the syntax described next: content is a special case of the syntax described next: content
recorded in the index at the given path. recorded in the index at the given path.
A path starting with './' or '../' is relative to current working directory. A path starting with './' or '../' is relative to current working directory.
@ -136,9 +136,9 @@ the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.
the same tree structure with the working tree. the same tree structure with the working tree.
* A colon, optionally followed by a stage number (0 to 3) and a * A colon, optionally followed by a stage number (0 to 3) and a
colon, followed by a path (e.g. `:0:README`); this names a blob object in the colon, followed by a path (e.g. ':0:README'); this names a blob object in the
index at the given path. Missing stage number (and the colon index at the given path. Missing stage number (and the colon
that follows it, e.g. `:README`) names a stage 0 entry. During a merge, stage that follows it, e.g. ':README') names a stage 0 entry. During a merge, stage
1 is the common ancestor, stage 2 is the target branch's version 1 is the common ancestor, stage 2 is the target branch's version
(typically the current branch), and stage 3 is the version from (typically the current branch), and stage 3 is the version from
the branch being merged. the branch being merged.
@ -175,31 +175,31 @@ G H I J
SPECIFYING RANGES SPECIFYING RANGES
----------------- -----------------
History traversing commands such as 'git log' operate on a set History traversing commands such as `git log` operate on a set
of commits, not just a single commit. To these commands, of commits, not just a single commit. To these commands,
specifying a single revision with the notation described in the specifying a single revision with the notation described in the
previous section means the set of commits reachable from that previous section means the set of commits reachable from that
commit, following the commit ancestry chain. commit, following the commit ancestry chain.
To exclude commits reachable from a commit, a prefix `{caret}` To exclude commits reachable from a commit, a prefix '{caret}'
notation is used. E.g. `{caret}r1 r2` means commits reachable notation is used. E.g. '{caret}r1 r2' means commits reachable
from `r2` but exclude the ones reachable from `r1`. from 'r2' but exclude the ones reachable from 'r1'.
This set operation appears so often that there is a shorthand This set operation appears so often that there is a shorthand
for it. When you have two commits `r1` and `r2` (named according for it. When you have two commits 'r1' and 'r2' (named according
to the syntax explained in SPECIFYING REVISIONS above), you can ask to the syntax explained in SPECIFYING REVISIONS above), you can ask
for commits that are reachable from r2 excluding those that are reachable for commits that are reachable from r2 excluding those that are reachable
from r1 by `{caret}r1 r2` and it can be written as `r1..r2`. from r1 by '{caret}r1 r2' and it can be written as 'r1..r2'.
A similar notation `r1\...r2` is called symmetric difference A similar notation 'r1\...r2' is called symmetric difference
of `r1` and `r2` and is defined as of 'r1' and 'r2' and is defined as
`r1 r2 --not $(git merge-base --all r1 r2)`. 'r1 r2 --not $(git merge-base --all r1 r2)'.
It is the set of commits that are reachable from either one of It is the set of commits that are reachable from either one of
`r1` or `r2` but not from both. 'r1' or 'r2' but not from both.
Two other shorthands for naming a set that is formed by a commit Two other shorthands for naming a set that is formed by a commit
and its parent commits exist. The `r1{caret}@` notation means all and its parent commits exist. The 'r1{caret}@' notation means all
parents of `r1`. `r1{caret}!` includes commit `r1` but excludes parents of 'r1'. 'r1{caret}!' includes commit 'r1' but excludes
all of its parents. all of its parents.
Here are a handful of examples: Here are a handful of examples: