From: Junio C Hamano Date: Mon, 7 Jul 2008 09:11:28 +0000 (-0700) Subject: Merge branch 'maint' X-Git-Tag: v1.6.0-rc0~124 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/585ad90c804a501415f03926c1ef67a34cb37cda?ds=inline;hp=-c Merge branch 'maint' * maint: Fix grammar in git-rev-parse(1). --- 585ad90c804a501415f03926c1ef67a34cb37cda diff --combined Documentation/git-rev-parse.txt index 0501a87025,ba65bfa16b..378a3124ac --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@@ -8,23 -8,23 +8,23 @@@ git-rev-parse - Pick out and massage pa SYNOPSIS -------- -'git-rev-parse' [ --option ] ... +'git rev-parse' [ --option ] ... DESCRIPTION ----------- Many git porcelainish commands take mixture of flags (i.e. parameters that begin with a dash '-') and parameters -meant for underlying `git-rev-list` command they use internally -and flags and parameters for other commands they use as the -downstream of `git-rev-list`. This command is used to +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 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 +32,11 @@@ --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 +64,7 @@@ 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 @@@ -128,13 -128,13 +128,13 @@@ --since=datestring:: --after=datestring:: - Parses the date string, and outputs corresponding - --max-age= parameter for git-rev-list command. + Parse the date string, and output the corresponding + --max-age= parameter for 'git-rev-list'. --until=datestring:: --before=datestring:: - Parses the date string, and outputs corresponding - --min-age= parameter for git-rev-list command. + Parse the date string, and output the corresponding + --min-age= parameter for 'git-rev-list'. ...:: Flags and parameters to be parsed. @@@ -155,7 -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 +278,7 @@@ G H I 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 @@@ -296,14 -296,14 +296,14 @@@ reachable from `r1` from the set of com A similar notation "`r1\...r2`" is called symmetric difference 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 `r1` or `r2` but not from both. Two other shorthands for naming a set that is formed by a commit - and its parent commits exists. `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 - its all parents. + all of its parents. Here are a handful of examples: @@@ -319,7 -319,7 +319,7 @@@ 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 +331,7 @@@ usage on the standard error stream, an 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. @@@ -384,7 -384,7 +384,7 @@@ bar= some cool option --bar with a An option group Header C? option C with an optional argument" -eval `echo "$OPTS_SPEC" | git-rev-parse --parseopt -- "$@" || echo exit $?` +eval `echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?` ------------ EXAMPLES