Skip to content

Commit

Permalink
doc: fix grammar rules in commands'syntax
Browse files Browse the repository at this point in the history
According to the coding guidelines, the placeholders must:
 * be in small letters
 * enclosed in angle brackets

Some other rules are also applied.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
  • Loading branch information
jnavila committed Oct 26, 2021
1 parent 9d530dc commit 605236f
Show file tree
Hide file tree
Showing 25 changed files with 79 additions and 79 deletions.
4 changes: 2 additions & 2 deletions Documentation/git-archimport.txt
Expand Up @@ -9,8 +9,8 @@ git-archimport - Import a GNU Arch repository into Git
SYNOPSIS
--------
[verse]
'git archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir]
<archive/branch>[:<git-branch>] ...
'git archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D <depth>] [-t <tempdir>]
<archive>/<branch>[:<git-branch>]...

DESCRIPTION
-----------
Expand Down
8 changes: 4 additions & 4 deletions Documentation/git-checkout.txt
Expand Up @@ -11,7 +11,7 @@ SYNOPSIS
'git checkout' [-q] [-f] [-m] [<branch>]
'git checkout' [-q] [-f] [-m] --detach [<branch>]
'git checkout' [-q] [-f] [-m] [--detach] <commit>
'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>]
'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new-branch>] [<start-point>]
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]
'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]
Expand Down Expand Up @@ -43,7 +43,7 @@ You could omit `<branch>`, in which case the command degenerates to
rather expensive side-effects to show only the tracking information,
if exists, for the current branch.

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

Specifying `-b` causes a new branch to be created as if
linkgit:git-branch[1] were called and then checked out. In
Expand Down Expand Up @@ -145,11 +145,11 @@ as `ours` (i.e. "our shared canonical history"), while what you did
on your side branch as `theirs` (i.e. "one contributor's work on top
of it").

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

-B <new_branch>::
-B <new-branch>::
Creates the branch `<new_branch>` and start it at `<start_point>`;
if it already exists, then reset it to `<start_point>`. This is
equivalent to running "git branch" with "-f"; see
Expand Down
6 changes: 3 additions & 3 deletions Documentation/git-cherry-pick.txt
Expand Up @@ -8,7 +8,7 @@ git-cherry-pick - Apply the changes introduced by some existing commits
SYNOPSIS
--------
[verse]
'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff]
'git cherry-pick' [--edit] [-n] [-m <parent-number>] [-s] [-x] [--ff]
[-S[<keyid>]] <commit>...
'git cherry-pick' (--continue | --skip | --abort | --quit)

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

-m parent-number::
--mainline parent-number::
-m <parent-number>::
--mainline <parent-number>::
Usually you cannot cherry-pick a merge because you do not know which
side of the merge should be considered the mainline. This
option specifies the parent number (starting from 1) of
Expand Down
36 changes: 18 additions & 18 deletions Documentation/git-config.txt
Expand Up @@ -9,20 +9,20 @@ git-config - Get and set repository or global options
SYNOPSIS
--------
[verse]
'git config' [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] name [value [value-pattern]]
'git config' [<file-option>] [--type=<type>] --add name value
'git config' [<file-option>] [--type=<type>] [--fixed-value] --replace-all name value [value-pattern]
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get name [value-pattern]
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all name [value-pattern]
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp name_regex [value-pattern]
'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch name URL
'git config' [<file-option>] [--fixed-value] --unset name [value-pattern]
'git config' [<file-option>] [--fixed-value] --unset-all name [value-pattern]
'git config' [<file-option>] --rename-section old_name new_name
'git config' [<file-option>] --remove-section name
'git config' [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] <name> [<value> [<value-pattern>]]
'git config' [<file-option>] [--type=<type>] --add <name> <value>
'git config' [<file-option>] [--type=<type>] [--fixed-value] --replace-all <name> <value> [<value-pattern>]
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get <name> [<value-pattern>]
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all <name> [<value-pattern>]
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp <name-regex> [<value-pattern>]
'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch <name> <URL>
'git config' [<file-option>] [--fixed-value] --unset <name> [<value-pattern>]
'git config' [<file-option>] [--fixed-value] --unset-all <name> [<value-pattern>]
'git config' [<file-option>] --rename-section <old-name> <new-name>
'git config' [<file-option>] --remove-section <name>
'git config' [<file-option>] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
'git config' [<file-option>] --get-color name [default]
'git config' [<file-option>] --get-colorbool name [stdout-is-tty]
'git config' [<file-option>] --get-color <name> [<default>]
'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>]
'git config' [<file-option>] -e | --edit

DESCRIPTION
Expand Down Expand Up @@ -102,7 +102,7 @@ OPTIONS
in which section and variable names are lowercased, but subsection
names are not.

--get-urlmatch name URL::
--get-urlmatch <name> <URL>::
When given a two-part name section.key, the value for
section.<url>.key whose <url> part matches the best to the
given URL is returned (if no such key exists, the value for
Expand Down Expand Up @@ -145,7 +145,7 @@ See also <<FILES>>.
read from or written to if `extensions.worktreeConfig` is
present. If not it's the same as `--local`.

-f config-file::
-f <config-file>::
--file config-file::
For writing options: write to the specified file rather than the
repository `.git/config`.
Expand All @@ -155,7 +155,7 @@ available files.
+
See also <<FILES>>.

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

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

Find the color setting for `name` (e.g. `color.diff`) and output
"true" or "false". `stdout-is-tty` should be either "true" or
Expand All @@ -257,7 +257,7 @@ Valid `<type>`'s include:
When the color setting for `name` is undefined, the command uses
`color.ui` as fallback.

--get-color name [default]::
--get-color <name> [<default>]::

Find the color configured for `name` (e.g. `color.diff.new`) and
output it as the ANSI color escape sequence to the standard
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-credential.txt
Expand Up @@ -8,7 +8,7 @@ git-credential - Retrieve and store user credentials
SYNOPSIS
--------
------------------
git credential <fill|approve|reject>
git credential [fill|approve|reject]
------------------

DESCRIPTION
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-cvsexportcommit.txt
Expand Up @@ -9,8 +9,8 @@ git-cvsexportcommit - Export a single commit to a CVS checkout
SYNOPSIS
--------
[verse]
'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot]
[-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID
'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d <cvsroot>]
[-w <cvs-workdir>] [-W] [-f] [-m <msgprefix>] [<parent-commit>] <commit-id>


DESCRIPTION
Expand Down
10 changes: 5 additions & 5 deletions Documentation/git-cvsimport.txt
Expand Up @@ -9,11 +9,11 @@ git-cvsimport - Salvage your data out of another SCM people love to hate
SYNOPSIS
--------
[verse]
'git cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>]
'git cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <cvsroot>]
[-A <author-conv-file>] [-p <options-for-cvsps>] [-P <file>]
[-C <git_repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>]
[-C <git-repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>]
[-a] [-m] [-M <regex>] [-S <regex>] [-L <commitlimit>]
[-r <remote>] [-R] [<CVS_module>]
[-r <remote>] [-R] [<CVS-module>]


DESCRIPTION
Expand Down Expand Up @@ -52,14 +52,14 @@ OPTIONS
-v::
Verbosity: let 'cvsimport' report what it is doing.

-d <CVSROOT>::
-d <cvsroot>::
The root of the CVS archive. May be local (a simple path) or remote;
currently, only the :local:, :ext: and :pserver: access methods
are supported. If not given, 'git cvsimport' will try to read it
from `CVS/Root`. If no such file exists, it checks for the
`CVSROOT` environment variable.

<CVS_module>::
<CVS-module>::
The CVS module you want to import. Relative to <CVSROOT>.
If not given, 'git cvsimport' tries to read it from
`CVS/Repository`.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-fsck.txt
Expand Up @@ -12,7 +12,7 @@ SYNOPSIS
'git fsck' [--tags] [--root] [--unreachable] [--cache] [--no-reflogs]
[--[no-]full] [--strict] [--verbose] [--lost-found]
[--[no-]dangling] [--[no-]progress] [--connectivity-only]
[--[no-]name-objects] [<object>*]
[--[no-]name-objects] [<object>...]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-gui.txt
Expand Up @@ -8,7 +8,7 @@ git-gui - A portable graphical interface to Git
SYNOPSIS
--------
[verse]
'git gui' [<command>] [arguments]
'git gui' [<command>] [<arguments>]

DESCRIPTION
-----------
Expand Down
6 changes: 3 additions & 3 deletions Documentation/git-help.txt
Expand Up @@ -9,14 +9,14 @@ SYNOPSIS
--------
[verse]
'git help' [-a|--all [--[no-]verbose]]
[[-i|--info] [-m|--man] [-w|--web]] [COMMAND|GUIDE]
[[-i|--info] [-m|--man] [-w|--web]] [<command>|<guide>]
'git help' [-g|--guides]
'git help' [-c|--config]

DESCRIPTION
-----------

With no options and no COMMAND or GUIDE given, the synopsis of the 'git'
With no options and no '<command>' or '<guide>' given, the synopsis of the 'git'
command and a list of the most commonly used Git commands are printed
on the standard output.

Expand All @@ -33,7 +33,7 @@ variables.

If an alias is given, git shows the definition of the alias on
standard output. To get the manual page for the aliased command, use
`git COMMAND --help`.
`git <command> --help`.

Note that `git --help ...` is identical to `git help ...` because the
former is internally converted into the latter.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-http-fetch.txt
Expand Up @@ -9,7 +9,7 @@ git-http-fetch - Download from a remote Git repository via HTTP
SYNOPSIS
--------
[verse]
'git http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [--stdin | --packfile=<hash> | <commit>] <url>
'git http-fetch' [-c] [-t] [-a] [-d] [-v] [-w <filename>] [--recover] [--stdin | --packfile=<hash> | <commit>] <url>

DESCRIPTION
-----------
Expand Down
13 changes: 6 additions & 7 deletions Documentation/git-http-push.txt
Expand Up @@ -63,16 +63,15 @@ of such patterns separated by a colon ":" (this means that a ref name
cannot have a colon in it). A single pattern '<name>' is just a
shorthand for '<name>:<name>'.

Each pattern pair consists of the source side (before the colon)
and the destination side (after the colon). The ref to be
pushed is determined by finding a match that matches the source
side, and where it is pushed is determined by using the
destination side.
Each pattern pair '<src>:<dst>' consists of the source side (before
the colon) and the destination side (after the colon). The ref to be
pushed is determined by finding a match that matches the source side,
and where it is pushed is determined by using the destination side.

- It is an error if <src> does not match exactly one of the
- It is an error if '<src>' does not match exactly one of the
local refs.

- If <dst> does not match any remote ref, either
- If '<dst>' does not match any remote ref, either

* it has to start with "refs/"; <dst> is used as the
destination literally in this case.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-init-db.txt
Expand Up @@ -9,7 +9,7 @@ git-init-db - Creates an empty Git repository
SYNOPSIS
--------
[verse]
'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]]
'git init-db' [-q | --quiet] [--bare] [--template=<template-directory>] [--separate-git-dir <git-dir>] [--shared[=<permissions>]]


DESCRIPTION
Expand Down
25 changes: 13 additions & 12 deletions Documentation/git-init.txt
Expand Up @@ -9,10 +9,10 @@ git-init - Create an empty Git repository or reinitialize an existing one
SYNOPSIS
--------
[verse]
'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
[--separate-git-dir <git dir>] [--object-format=<format>]
'git init' [-q | --quiet] [--bare] [--template=<template-directory>]
[--separate-git-dir <git-dir>] [--object-format=<format>]
[-b <branch-name> | --initial-branch=<branch-name>]
[--shared[=<permissions>]] [directory]
[--shared[=<permissions>]] [<directory>]


DESCRIPTION
Expand Down Expand Up @@ -57,12 +57,12 @@ values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default.
+
include::object-format-disclaimer.txt[]

--template=<template_directory>::
--template=<template-directory>::

Specify the directory from which templates will be used. (See the "TEMPLATE
DIRECTORY" section below.)

--separate-git-dir=<git dir>::
--separate-git-dir=<git-dir>::

Instead of initializing the repository as a directory to either `$GIT_DIR` or
`./.git/`, create a text file there containing the path to the actual
Expand All @@ -79,7 +79,7 @@ repository. If not specified, fall back to the default name (currently
`master`, but this is subject to change in the future; the name can be
customized via the `init.defaultBranch` configuration variable).

--shared[=(false|true|umask|group|all|world|everybody|0xxx)]::
--shared[=(false|true|umask|group|all|world|everybody|0<octal>)]::

Specify that the Git repository is to be shared amongst several users. This
allows users belonging to the same group to push into that
Expand Down Expand Up @@ -110,13 +110,14 @@ the repository permissions.

Same as 'group', but make the repository readable by all users.

'0xxx'::
'0<octal>'::

'0xxx' is an octal number and each file will have mode '0xxx'. '0xxx' will
override users' umask(2) value (and not only loosen permissions as 'group' and
'all' does). '0640' will create a repository which is group-readable, but not
group-writable or accessible to others. '0660' will create a repo that is
readable and writable to the current user and group, but inaccessible to others.
'0<octal>' is an octal number and each file will have mode
'0<octal>'. '0<octal>' will override users' umask(2) value (and not
only loosen permissions as 'group' and 'all' does). '0640' will create
a repository which is group-readable, but not group-writable or
accessible to others. '0660' will create a repo that is readable and
writable to the current user and group, but inaccessible to others.
--

By default, the configuration flag `receive.denyNonFastForwards` is enabled
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-log.txt
Expand Up @@ -9,7 +9,7 @@ git-log - Show commit logs
SYNOPSIS
--------
[verse]
'git log' [<options>] [<revision range>] [[--] <path>...]
'git log' [<options>] [<revision-range>] [[--] <path>...]

DESCRIPTION
-----------
Expand Down Expand Up @@ -81,7 +81,7 @@ produced by `--stat`, etc.

include::line-range-options.txt[]

<revision range>::
<revision-range>::
Show only commits in the specified revision range. When no
<revision range> is specified, it defaults to `HEAD` (i.e. the
whole history leading to the current commit). `origin..HEAD`
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-ls-files.txt
Expand Up @@ -10,8 +10,8 @@ SYNOPSIS
--------
[verse]
'git ls-files' [-z] [-t] [-v] [-f]
(--[cached|deleted|others|ignored|stage|unmerged|killed|modified])*
(-[c|d|o|i|s|u|k|m])*
[--(cached|deleted|others|ignored|stage|unmerged|killed|modified)...]
[-(c|d|o|i|s|u|k|m)...]
[--eol]
[--deduplicate]
[-x <pattern>|--exclude=<pattern>]
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-merge-index.txt
Expand Up @@ -9,7 +9,7 @@ git-merge-index - Run a merge for files needing merging
SYNOPSIS
--------
[verse]
'git merge-index' [-o] [-q] <merge-program> (-a | [--] <file>*)
'git merge-index' [-o] [-q] <merge-program> (-a | ( [--] <file>...) )

DESCRIPTION
-----------
Expand Down
6 changes: 3 additions & 3 deletions Documentation/git-p4.txt
Expand Up @@ -9,10 +9,10 @@ git-p4 - Import from and submit to Perforce repositories
SYNOPSIS
--------
[verse]
'git p4 clone' [<sync options>] [<clone options>] <p4 depot path>...
'git p4 sync' [<sync options>] [<p4 depot path>...]
'git p4 clone' [<sync-options>] [<clone-options>] <p4-depot-path>...
'git p4 sync' [<sync-options>] [<p4-depot-path>...]
'git p4 rebase'
'git p4 submit' [<submit options>] [<master branch name>]
'git p4 submit' [<submit-options>] [<master-branch-name>]


DESCRIPTION
Expand Down

0 comments on commit 605236f

Please sign in to comment.