diff options
author | Jonathan Nieder <jrnieder@uchicago.edu> | 2008-07-03 00:41:41 -0500 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2008-07-05 11:24:40 -0700 |
commit | ba020ef5eb5fca3d757bd580ff117adaf81ca079 (patch) | |
tree | 974c4e60c9bc212d0ce939b31e8fbb61b5fb1f07 /Documentation/git-rev-parse.txt | |
parent | 0979c106498f21838140313b485f90faf06f454f (diff) | |
download | git-ba020ef5eb5fca3d757bd580ff117adaf81ca079.tar.gz git-ba020ef5eb5fca3d757bd580ff117adaf81ca079.tar.xz |
manpages: italicize git command names (which were in teletype font)
The names of git commands are not meant to be entered at the
commandline; they are just names. So we render them in italics,
as is usual for command names in manpages.
Using
doit () {
perl -e 'for (<>) { s/\`(git-[^\`.]*)\`/'\''\1'\''/g; print }'
}
for i in git*.txt config.txt diff*.txt blame*.txt fetch*.txt i18n.txt \
merge*.txt pretty*.txt pull*.txt rev*.txt urls*.txt
do
doit <"$i" >"$i+" && mv "$i+" "$i"
done
git diff
.
Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-rev-parse.txt')
-rw-r--r-- | Documentation/git-rev-parse.txt | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 6825ae27c..0501a8702 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -15,16 +15,16 @@ DESCRIPTION Many git porcelainish commands take mixture of flags (i.e. parameters that begin with a dash '-') and parameters -meant for the underlying `git-rev-list` command they use internally +meant for the underlying 'git-rev-list' command they use internally and flags and parameters for the other commands they use -downstream of `git-rev-list`. This command is used to +downstream of 'git-rev-list'. This command is used to distinguish between them. OPTIONS ------- --parseopt:: - Use `git-rev-parse` in option parsing mode (see PARSEOPT section below). + Use 'git-rev-parse' in option parsing mode (see PARSEOPT section below). --keep-dash-dash:: Only meaningful in `--parseopt` mode. Tells the option parser to echo @@ -32,11 +32,11 @@ OPTIONS --revs-only:: Do not output flags and parameters not meant for - `git-rev-list` command. + 'git-rev-list' command. --no-revs:: Do not output flags and parameters meant for - `git-rev-list` command. + 'git-rev-list' command. --flags:: Do not output non-flag parameters. @@ -64,7 +64,7 @@ OPTIONS properly quoted for consumption by shell. Useful when you expect your parameter to contain whitespaces and newlines (e.g. when using pickaxe `-S` with - `git-diff-\*`). + 'git-diff-\*'). --not:: When showing object names, prefix them with '{caret}' and @@ -129,12 +129,12 @@ OPTIONS --since=datestring:: --after=datestring:: Parse the date string, and output the corresponding - --max-age= parameter for `git-rev-list`. + --max-age= parameter for 'git-rev-list'. --until=datestring:: --before=datestring:: Parse the date string, and output the corresponding - --min-age= parameter for `git-rev-list`. + --min-age= parameter for 'git-rev-list'. <args>...:: Flags and parameters to be parsed. @@ -155,7 +155,7 @@ blobs contained in a commit. name the same commit object if there are no other object in your repository whose object name starts with dae86e. -* An output from `git-describe`; i.e. a closest tag, followed by a +* An output from 'git-describe'; i.e. a closest tag, followed by a dash, a `g`, and an abbreviated object name. * A symbolic ref name. E.g. 'master' typically means the commit @@ -278,7 +278,7 @@ G H I J 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, specifying a single revision with the notation described in the previous section means the set of commits reachable from that @@ -319,7 +319,7 @@ Here are a handful of examples: PARSEOPT -------- -In `--parseopt` mode, `git-rev-parse` helps massaging options to bring to shell +In `--parseopt` mode, 'git-rev-parse' helps massaging options to bring to shell scripts the same facilities C builtins have. It works as an option normalizer (e.g. splits single switches aggregate values), a bit like `getopt(1)` does. @@ -331,7 +331,7 @@ usage on the standard error stream, and exits with code 129. Input Format ~~~~~~~~~~~~ -`git-rev-parse --parseopt` input format is fully text based. It has two parts, +'git-rev-parse --parseopt' input format is fully text based. It has two parts, separated by a line that contains only `--`. The lines before the separator (should be more than one) are used for the usage. The lines after the separator describe the options. |