Merge branch 'ja/misc-doc-fixes'

Doc fixes.

* ja/misc-doc-fixes:
  doc: fix the bnf like style of some commands
  doc: git-remote fix ups
  doc: use linkgit macro where needed.
  git-bisect-lk2009: make continuation of list indented
This commit is contained in:
Junio C Hamano
2020-10-08 21:53:26 -07:00
5 changed files with 21 additions and 21 deletions

View File

@ -473,7 +473,7 @@ Z-Z
------------- -------------
2) starting from the "good" ends of the graph, associate to each 2) starting from the "good" ends of the graph, associate to each
commit the number of ancestors it has plus one commit the number of ancestors it has plus one
For example with the following graph where H is the "bad" commit and A For example with the following graph where H is the "bad" commit and A
and D are some parents of some "good" commits: and D are some parents of some "good" commits:
@ -514,7 +514,7 @@ D---E
------------- -------------
4) the best bisection point is the commit with the highest associated 4) the best bisection point is the commit with the highest associated
number number
So in the above example the best bisection point is commit C. So in the above example the best bisection point is commit C.
@ -580,8 +580,8 @@ good or a bad commit does not give more or less information).
Let's also suppose that we have a cleaned up graph like one after step Let's also suppose that we have a cleaned up graph like one after step
1) in the bisection algorithm above. This means that we can measure 1) in the bisection algorithm above. This means that we can measure
the information we get in terms of number of commit we can remove from the information we get in terms of number of commit we can remove
the graph.. from the graph..
And let's take a commit X in the graph. And let's take a commit X in the graph.
@ -689,18 +689,18 @@ roughly the following steps:
6) sort the commit by decreasing associated value 6) sort the commit by decreasing associated value
7) if the first commit has not been skipped, we can return it and stop 7) if the first commit has not been skipped, we can return it and stop
here here
8) otherwise filter out all the skipped commits in the sorted list 8) otherwise filter out all the skipped commits in the sorted list
9) use a pseudo random number generator (PRNG) to generate a random 9) use a pseudo random number generator (PRNG) to generate a random
number between 0 and 1 number between 0 and 1
10) multiply this random number with its square root to bias it toward 10) multiply this random number with its square root to bias it toward
0 0
11) multiply the result by the number of commits in the filtered list 11) multiply the result by the number of commits in the filtered list
to get an index into this list to get an index into this list
12) return the commit at the computed index 12) return the commit at the computed index

View File

@ -209,7 +209,7 @@ providing this option will cause it to die.
Use \0 as the delimiter for pathnames in the output, and print Use \0 as the delimiter for pathnames in the output, and print
them verbatim. Without this option, pathnames with "unusual" them verbatim. Without this option, pathnames with "unusual"
characters are quoted as explained for the configuration characters are quoted as explained for the configuration
variable core.quotePath (see git-config(1)). variable core.quotePath (see linkgit:git-config[1]).
-o:: -o::
--only-matching:: --only-matching::

View File

@ -70,7 +70,7 @@ repository.
+ +
If this is reinitialization, the repository will be moved to the specified path. If this is reinitialization, the repository will be moved to the specified path.
-b <branch-name:: -b <branch-name>::
--initial-branch=<branch-name>:: --initial-branch=<branch-name>::
Use the specified name for the initial branch in the newly created repository. Use the specified name for the initial branch in the newly created repository.

View File

@ -10,7 +10,7 @@ SYNOPSIS
-------- --------
[verse] [verse]
'git remote' [-v | --verbose] 'git remote' [-v | --verbose]
'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <name> <url> 'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=(fetch|push)] <name> <url>
'git remote rename' <old> <new> 'git remote rename' <old> <new>
'git remote remove' <name> 'git remote remove' <name>
'git remote set-head' <name> (-a | --auto | -d | --delete | <branch>) 'git remote set-head' <name> (-a | --auto | -d | --delete | <branch>)
@ -35,7 +35,7 @@ OPTIONS
-v:: -v::
--verbose:: --verbose::
Be a little more verbose and show remote url after name. Be a little more verbose and show remote url after name.
NOTE: This must be placed between `remote` and `subcommand`. NOTE: This must be placed between `remote` and subcommand.
COMMANDS COMMANDS
@ -46,7 +46,7 @@ subcommands are available to perform operations on the remotes.
'add':: 'add'::
Adds a remote named <name> for the repository at Add a remote named <name> for the repository at
<url>. The command `git fetch <name>` can then be used to create and <url>. The command `git fetch <name>` can then be used to create and
update remote-tracking branches <name>/<branch>. update remote-tracking branches <name>/<branch>.
+ +
@ -109,13 +109,13 @@ With `-d` or `--delete`, the symbolic ref `refs/remotes/<name>/HEAD` is deleted.
+ +
With `-a` or `--auto`, the remote is queried to determine its `HEAD`, then the With `-a` or `--auto`, the remote is queried to determine its `HEAD`, then the
symbolic-ref `refs/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote symbolic-ref `refs/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote
`HEAD` is pointed at `next`, "`git remote set-head origin -a`" will set `HEAD` is pointed at `next`, `git remote set-head origin -a` will set
the symbolic-ref `refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will the symbolic-ref `refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will
only work if `refs/remotes/origin/next` already exists; if not it must be only work if `refs/remotes/origin/next` already exists; if not it must be
fetched first. fetched first.
+ +
Use `<branch>` to set the symbolic-ref `refs/remotes/<name>/HEAD` explicitly. e.g., "git Use `<branch>` to set the symbolic-ref `refs/remotes/<name>/HEAD` explicitly. e.g., `git
remote set-head origin master" will set the symbolic-ref `refs/remotes/origin/HEAD` to remote set-head origin master` will set the symbolic-ref `refs/remotes/origin/HEAD` to
`refs/remotes/origin/master`. This will only work if `refs/remotes/origin/master`. This will only work if
`refs/remotes/origin/master` already exists; if not it must be fetched first. `refs/remotes/origin/master` already exists; if not it must be fetched first.
+ +
@ -127,7 +127,7 @@ This can be used to track a subset of the available remote branches
after the initial setup for a remote. after the initial setup for a remote.
+ +
The named branches will be interpreted as if specified with the The named branches will be interpreted as if specified with the
`-t` option on the 'git remote add' command line. `-t` option on the `git remote add` command line.
+ +
With `--add`, instead of replacing the list of currently tracked With `--add`, instead of replacing the list of currently tracked
branches, adds to that list. branches, adds to that list.
@ -181,16 +181,16 @@ fetch --prune <name>`, except that no new references will be fetched.
See the PRUNING section of linkgit:git-fetch[1] for what it'll prune See the PRUNING section of linkgit:git-fetch[1] for what it'll prune
depending on various configuration. depending on various configuration.
+ +
With `--dry-run` option, report what branches will be pruned, but do not With `--dry-run` option, report what branches would be pruned, but do not
actually prune them. actually prune them.
'update':: 'update'::
Fetch updates for remotes or remote groups in the repository as defined by Fetch updates for remotes or remote groups in the repository as defined by
remotes.<group>. If neither group nor remote is specified on the command line, `remotes.<group>`. If neither group nor remote is specified on the command line,
the configuration parameter remotes.default will be used; if the configuration parameter remotes.default will be used; if
remotes.default is not defined, all remotes which do not have the remotes.default is not defined, all remotes which do not have the
configuration parameter remote.<name>.skipDefaultUpdate set to true will configuration parameter `remote.<name>.skipDefaultUpdate` set to true will
be updated. (See linkgit:git-config[1]). be updated. (See linkgit:git-config[1]).
+ +
With `--prune` option, run pruning against all the remotes that are updated. With `--prune` option, run pruning against all the remotes that are updated.

View File

@ -1308,7 +1308,7 @@ static int module_summary(int argc, const char **argv, const char *prefix)
}; };
const char *const git_submodule_helper_usage[] = { const char *const git_submodule_helper_usage[] = {
N_("git submodule--helper summary [<options>] [commit] [--] [<path>]"), N_("git submodule--helper summary [<options>] [<commit>] [--] [<path>]"),
NULL NULL
}; };