Skip to content

Commit f722049

Browse files
gitstergitster
committed
Merge branch 'ja/doc-cleanup' into next
Doc update. * ja/doc-cleanup: init doc: --shared=0xxx does not give umask but perm bits doc: git-init: clarify file modes in octal. doc: git-http-push: describe the refs as pattern pairs doc: uniformize <URL> placeholders' case doc: use three dots for indicating repetition instead of star doc: git-ls-files: express options as optional alternatives doc: use only hyphens as word separators in placeholders doc: express grammar placeholders between angle brackets doc: split placeholders as individual tokens doc: fix git credential synopsis
2 parents d7ea169 + f9b2b66 commit f722049

39 files changed

+168
-166
lines changed

‎Documentation/date-formats.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ The `GIT_AUTHOR_DATE` and `GIT_COMMITTER_DATE` environment variables
55
support the following date formats:
66

77
Git internal format::
8-
It is `<unix timestamp> <time zone offset>`, where `<unix
9-
timestamp>` is the number of seconds since the UNIX epoch.
10-
`<time zone offset>` is a positive or negative offset from UTC.
8+
It is `<unix-timestamp> <time-zone-offset>`, where
9+
`<unix-timestamp>` is the number of seconds since the UNIX epoch.
10+
`<time-zone-offset>` is a positive or negative offset from UTC.
1111
For example CET (which is 1 hour ahead of UTC) is `+0100`.
1212

1313
RFC 2822::

‎Documentation/git-archimport.txt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ git-archimport - Import a GNU Arch repository into Git
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir]
13-
<archive/branch>[:<git-branch>] ...
12+
'git archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D <depth>] [-t <tempdir>]
13+
<archive>/<branch>[:<git-branch>]...
1414

1515
DESCRIPTION
1616
-----------
1717
Imports a project from one or more GNU Arch repositories.
1818
It will follow branches
19-
and repositories within the namespaces defined by the <archive/branch>
19+
and repositories within the namespaces defined by the <archive>/<branch>
2020
parameters supplied. If it cannot find the remote branch a merge comes from
2121
it will just import it as a regular commit. If it can find it, it will mark it
2222
as a merge whenever possible (see discussion below).
@@ -27,7 +27,7 @@ import new branches within the provided roots.
2727

2828
It expects to be dealing with one project only. If it sees
2929
branches that have different roots, it will refuse to run. In that case,
30-
edit your <archive/branch> parameters to define clearly the scope of the
30+
edit your <archive>/<branch> parameters to define clearly the scope of the
3131
import.
3232

3333
'git archimport' uses `tla` extensively in the background to access the
@@ -42,7 +42,7 @@ incremental imports.
4242

4343
While 'git archimport' will try to create sensible branch names for the
4444
archives that it imports, it is also possible to specify Git branch names
45-
manually. To do so, write a Git branch name after each <archive/branch>
45+
manually. To do so, write a Git branch name after each <archive>/<branch>
4646
parameter, separated by a colon. This way, you can shorten the Arch
4747
branch names and convert Arch jargon to Git jargon, for example mapping a
4848
"PROJECT{litdd}devo{litdd}VERSION" branch to "master".
@@ -104,8 +104,8 @@ OPTIONS
104104
Override the default tempdir.
105105

106106

107-
<archive/branch>::
108-
Archive/branch identifier in a format that `tla log` understands.
107+
<archive>/<branch>::
108+
<archive>/<branch> identifier in a format that `tla log` understands.
109109

110110

111111
GIT

‎Documentation/git-checkout.txt‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ SYNOPSIS
1111
'git checkout' [-q] [-f] [-m] [<branch>]
1212
'git checkout' [-q] [-f] [-m] --detach [<branch>]
1313
'git checkout' [-q] [-f] [-m] [--detach] <commit>
14-
'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>]
14+
'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new-branch>] [<start-point>]
1515
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...
1616
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]
1717
'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]
@@ -43,7 +43,7 @@ You could omit `<branch>`, in which case the command degenerates to
4343
rather expensive side-effects to show only the tracking information,
4444
if exists, for the current branch.
4545

46-
'git checkout' -b|-B <new_branch> [<start point>]::
46+
'git checkout' -b|-B <new-branch> [<start-point>]::
4747

4848
Specifying `-b` causes a new branch to be created as if
4949
linkgit:git-branch[1] were called and then checked out. In
@@ -52,11 +52,11 @@ if exists, for the current branch.
5252
`--track` without `-b` implies branch creation; see the
5353
description of `--track` below.
5454
+
55-
If `-B` is given, `<new_branch>` is created if it doesn't exist; otherwise, it
55+
If `-B` is given, `<new-branch>` is created if it doesn't exist; otherwise, it
5656
is reset. This is the transactional equivalent of
5757
+
5858
------------
59-
$ git branch -f <branch> [<start point>]
59+
$ git branch -f <branch> [<start-point>]
6060
$ git checkout <branch>
6161
------------
6262
+
@@ -145,13 +145,13 @@ as `ours` (i.e. "our shared canonical history"), while what you did
145145
on your side branch as `theirs` (i.e. "one contributor's work on top
146146
of it").
147147

148-
-b <new_branch>::
149-
Create a new branch named `<new_branch>` and start it at
150-
`<start_point>`; see linkgit:git-branch[1] for details.
148+
-b <new-branch>::
149+
Create a new branch named `<new-branch>` and start it at
150+
`<start-point>`; see linkgit:git-branch[1] for details.
151151

152-
-B <new_branch>::
153-
Creates the branch `<new_branch>` and start it at `<start_point>`;
154-
if it already exists, then reset it to `<start_point>`. This is
152+
-B <new-branch>::
153+
Creates the branch `<new-branch>` and start it at `<start-point>`;
154+
if it already exists, then reset it to `<start-point>`. This is
155155
equivalent to running "git branch" with "-f"; see
156156
linkgit:git-branch[1] for details.
157157

@@ -210,16 +210,16 @@ variable.
210210
`<commit>` is not a branch name. See the "DETACHED HEAD" section
211211
below for details.
212212

213-
--orphan <new_branch>::
214-
Create a new 'orphan' branch, named `<new_branch>`, started from
215-
`<start_point>` and switch to it. The first commit made on this
213+
--orphan <new-branch>::
214+
Create a new 'orphan' branch, named `<new-branch>`, started from
215+
`<start-point>` and switch to it. The first commit made on this
216216
new branch will have no parents and it will be the root of a new
217217
history totally disconnected from all the other branches and
218218
commits.
219219
+
220220
The index and the working tree are adjusted as if you had previously run
221-
`git checkout <start_point>`. This allows you to start a new history
222-
that records a set of paths similar to `<start_point>` by easily running
221+
`git checkout <start-point>`. This allows you to start a new history
222+
that records a set of paths similar to `<start-point>` by easily running
223223
`git commit -a` to make the root commit.
224224
+
225225
This can be useful when you want to publish the tree from a commit
@@ -229,7 +229,7 @@ whose full history contains proprietary or otherwise encumbered bits of
229229
code.
230230
+
231231
If you want to start a disconnected history that records a set of paths
232-
that is totally different from the one of `<start_point>`, then you should
232+
that is totally different from the one of `<start-point>`, then you should
233233
clear the index and the working tree right after creating the orphan
234234
branch by running `git rm -rf .` from the top level of the working tree.
235235
Afterwards you will be ready to prepare your new files, repopulating the
@@ -341,10 +341,10 @@ As a special case, you may use `A...B` as a shortcut for the
341341
merge base of `A` and `B` if there is exactly one merge base. You can
342342
leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
343343

344-
<new_branch>::
344+
<new-branch>::
345345
Name for the new branch.
346346

347-
<start_point>::
347+
<start-point>::
348348
The name of a commit at which to start the new branch; see
349349
linkgit:git-branch[1] for details. Defaults to `HEAD`.
350350
+

‎Documentation/git-cherry-pick.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-cherry-pick - Apply the changes introduced by some existing commits
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff]
11+
'git cherry-pick' [--edit] [-n] [-m <parent-number>] [-s] [-x] [--ff]
1212
[-S[<keyid>]] <commit>...
1313
'git cherry-pick' (--continue | --skip | --abort | --quit)
1414

@@ -81,8 +81,8 @@ OPTIONS
8181
described above, and `-r` was to disable it. Now the
8282
default is not to do `-x` so this option is a no-op.
8383

84-
-m parent-number::
85-
--mainline parent-number::
84+
-m <parent-number>::
85+
--mainline <parent-number>::
8686
Usually you cannot cherry-pick a merge because you do not know which
8787
side of the merge should be considered the mainline. This
8888
option specifies the parent number (starting from 1) of

‎Documentation/git-clone.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ git-clone - Clone a repository into a new directory
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git clone' [--template=<template_directory>]
12+
'git clone' [--template=<template-directory>]
1313
[-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
1414
[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
15-
[--dissociate] [--separate-git-dir <git dir>]
15+
[--dissociate] [--separate-git-dir <git-dir>]
1616
[--depth <depth>] [--[no-]single-branch] [--no-tags]
1717
[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
1818
[--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]
@@ -211,7 +211,7 @@ objects from the source repository into a pack in the cloned repository.
211211
via ssh, this specifies a non-default path for the command
212212
run on the other end.
213213

214-
--template=<template_directory>::
214+
--template=<template-directory>::
215215
Specify the directory from which templates will be used;
216216
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
217217

@@ -294,7 +294,7 @@ or `--mirror` is given)
294294
superproject's recorded SHA-1. Equivalent to passing `--remote` to
295295
`git submodule update`.
296296

297-
--separate-git-dir=<git dir>::
297+
--separate-git-dir=<git-dir>::
298298
Instead of placing the cloned repository where it is supposed
299299
to be, place the cloned repository at the specified directory,
300300
then make a filesystem-agnostic Git symbolic link to there.

‎Documentation/git-config.txt‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ git-config - Get and set repository or global options
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git config' [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] name [value [value-pattern]]
13-
'git config' [<file-option>] [--type=<type>] --add name value
14-
'git config' [<file-option>] [--type=<type>] [--fixed-value] --replace-all name value [value-pattern]
15-
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get name [value-pattern]
16-
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all name [value-pattern]
17-
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp name_regex [value-pattern]
18-
'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch name URL
19-
'git config' [<file-option>] [--fixed-value] --unset name [value-pattern]
20-
'git config' [<file-option>] [--fixed-value] --unset-all name [value-pattern]
21-
'git config' [<file-option>] --rename-section old_name new_name
22-
'git config' [<file-option>] --remove-section name
12+
'git config' [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] <name> [<value> [<value-pattern>]]
13+
'git config' [<file-option>] [--type=<type>] --add <name> <value>
14+
'git config' [<file-option>] [--type=<type>] [--fixed-value] --replace-all <name> <value> [<value-pattern>]
15+
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get <name> [<value-pattern>]
16+
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all <name> [<value-pattern>]
17+
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp <name-regex> [<value-pattern>]
18+
'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch <name> <URL>
19+
'git config' [<file-option>] [--fixed-value] --unset <name> [<value-pattern>]
20+
'git config' [<file-option>] [--fixed-value] --unset-all <name> [<value-pattern>]
21+
'git config' [<file-option>] --rename-section <old-name> <new-name>
22+
'git config' [<file-option>] --remove-section <name>
2323
'git config' [<file-option>] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
24-
'git config' [<file-option>] --get-color name [default]
25-
'git config' [<file-option>] --get-colorbool name [stdout-is-tty]
24+
'git config' [<file-option>] --get-color <name> [<default>]
25+
'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>]
2626
'git config' [<file-option>] -e | --edit
2727

2828
DESCRIPTION
@@ -102,9 +102,9 @@ OPTIONS
102102
in which section and variable names are lowercased, but subsection
103103
names are not.
104104

105-
--get-urlmatch name URL::
105+
--get-urlmatch <name> <URL>::
106106
When given a two-part name section.key, the value for
107-
section.<url>.key whose <url> part matches the best to the
107+
section.<URL>.key whose <URL> part matches the best to the
108108
given URL is returned (if no such key exists, the value for
109109
section.key is used as a fallback). When given just the
110110
section as name, do so for all the keys in the section and
@@ -145,8 +145,8 @@ See also <<FILES>>.
145145
read from or written to if `extensions.worktreeConfig` is
146146
present. If not it's the same as `--local`.
147147

148-
-f config-file::
149-
--file config-file::
148+
-f <config-file>::
149+
--file <config-file>::
150150
For writing options: write to the specified file rather than the
151151
repository `.git/config`.
152152
+
@@ -155,7 +155,7 @@ available files.
155155
+
156156
See also <<FILES>>.
157157

158-
--blob blob::
158+
--blob <blob>::
159159
Similar to `--file` but use the given blob instead of a file. E.g.
160160
you can use 'master:.gitmodules' to read values from the file
161161
'.gitmodules' in the master branch. See "SPECIFYING REVISIONS"
@@ -246,18 +246,18 @@ Valid `<type>`'s include:
246246
all queried config options with the scope of that value
247247
(local, global, system, command).
248248

249-
--get-colorbool name [stdout-is-tty]::
249+
--get-colorbool <name> [<stdout-is-tty>]::
250250

251-
Find the color setting for `name` (e.g. `color.diff`) and output
252-
"true" or "false". `stdout-is-tty` should be either "true" or
251+
Find the color setting for `<name>` (e.g. `color.diff`) and output
252+
"true" or "false". `<stdout-is-tty>` should be either "true" or
253253
"false", and is taken into account when configuration says
254-
"auto". If `stdout-is-tty` is missing, then checks the standard
254+
"auto". If `<stdout-is-tty>` is missing, then checks the standard
255255
output of the command itself, and exits with status 0 if color
256256
is to be used, or exits with status 1 otherwise.
257257
When the color setting for `name` is undefined, the command uses
258258
`color.ui` as fallback.
259259

260-
--get-color name [default]::
260+
--get-color <name> [<default>]::
261261

262262
Find the color configured for `name` (e.g. `color.diff.new`) and
263263
output it as the ANSI color escape sequence to the standard

‎Documentation/git-credential.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-credential - Retrieve and store user credentials
88
SYNOPSIS
99
--------
1010
------------------
11-
git credential <fill|approve|reject>
11+
'git credential' (fill|approve|reject)
1212
------------------
1313

1414
DESCRIPTION

‎Documentation/git-cvsexportcommit.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ git-cvsexportcommit - Export a single commit to a CVS checkout
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot]
13-
[-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID
12+
'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d <cvsroot>]
13+
[-w <cvs-workdir>] [-W] [-f] [-m <msgprefix>] [<parent-commit>] <commit-id>
1414

1515

1616
DESCRIPTION

‎Documentation/git-cvsimport.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ SYNOPSIS
1111
[verse]
1212
'git cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>]
1313
[-A <author-conv-file>] [-p <options-for-cvsps>] [-P <file>]
14-
[-C <git_repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>]
15-
[-a] [-m] [-M <regex>] [-S <regex>] [-L <commitlimit>]
16-
[-r <remote>] [-R] [<CVS_module>]
14+
[-C <git-repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>]
15+
[-a] [-m] [-M <regex>] [-S <regex>] [-L <commit-limit>]
16+
[-r <remote>] [-R] [<CVS-module>]
1717

1818

1919
DESCRIPTION
@@ -59,7 +59,7 @@ OPTIONS
5959
from `CVS/Root`. If no such file exists, it checks for the
6060
`CVSROOT` environment variable.
6161

62-
<CVS_module>::
62+
<CVS-module>::
6363
The CVS module you want to import. Relative to <CVSROOT>.
6464
If not given, 'git cvsimport' tries to read it from
6565
`CVS/Repository`.

‎Documentation/git-diff-files.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-diff-files - Compares files in the working tree and the index
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>...]
12+
'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common-diff-options>] [<path>...]
1313

1414
DESCRIPTION
1515
-----------

0 commit comments

Comments
 (0)