Skip to content

Commit 5cf7dfe

Browse files
jnavilagitster
authored andcommitted
doc: git-init: apply new documentation formatting guidelines
Signed-off-by: Jean-Noël Avila <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 71d9f5a commit 5cf7dfe

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

Documentation/config/init.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ ifndef::git-init[]
33
:see-git-init: (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
44
endif::[]
55

6-
init.templateDir::
6+
`init.templateDir`::
77
Specify the directory from which templates will be copied. {see-git-init}
8-
init.defaultBranch::
8+
`init.defaultBranch`::
99
Allows overriding the default branch name e.g. when initializing
1010
a new repository.

Documentation/git-init.txt

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ git-init - Create an empty Git repository or reinitialize an existing one
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git init' [-q | --quiet] [--bare] [--template=<template-directory>]
13-
[--separate-git-dir <git-dir>] [--object-format=<format>]
14-
[--ref-format=<format>]
15-
[-b <branch-name> | --initial-branch=<branch-name>]
16-
[--shared[=<permissions>]] [<directory>]
12+
`git init` [`-q` | `--quiet`] [`--bare`] [++--template=++__<template-directory>__]
13+
[`--separate-git-dir` _<git-dir>_] [++--object-format=++__<format>__]
14+
[++--ref-format=++__<format>__]
15+
[`-b` _<branch-name>_ | ++--initial-branch=++__<branch-name>__]
16+
[++--shared++[++=++__<permissions>__]] [_<directory>_]
1717

1818

1919
DESCRIPTION
@@ -41,35 +41,35 @@ the repository to another place if `--separate-git-dir` is given).
4141
OPTIONS
4242
-------
4343

44-
-q::
45-
--quiet::
44+
`-q`::
45+
`--quiet`::
4646

4747
Only print error and warning messages; all other output will be suppressed.
4848

49-
--bare::
49+
`--bare`::
5050

5151
Create a bare repository. If `GIT_DIR` environment is not set, it is set to the
5252
current working directory.
5353

54-
--object-format=<format>::
54+
++--object-format=++__<format>__::
5555

5656
Specify the given object _<format>_ (hash algorithm) for the repository. The valid
5757
values are `sha1` and (if enabled) `sha256`. `sha1` is the default.
5858
+
5959
include::object-format-disclaimer.txt[]
6060

61-
--ref-format=<format>::
61+
++--ref-format=++__<format>__::
6262

6363
Specify the given ref storage _<format>_ for the repository. The valid values are:
6464
+
6565
include::ref-storage-format.txt[]
6666

67-
--template=<template-directory>::
67+
++--template=++__<template-directory>__::
6868

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

72-
--separate-git-dir=<git-dir>::
72+
++--separate-git-dir=++__<git-dir>__::
7373

7474
Instead of initializing the repository as a directory to either `$GIT_DIR` or
7575
`./.git/`, create a text file there containing the path to the actual
@@ -78,53 +78,53 @@ repository.
7878
+
7979
If this is a reinitialization, the repository will be moved to the specified path.
8080

81-
-b <branch-name>::
82-
--initial-branch=<branch-name>::
81+
`-b` _<branch-name>_::
82+
++--initial-branch=++__<branch-name>__::
8383

8484
Use _<branch-name>_ for the initial branch in the newly created
8585
repository. If not specified, fall back to the default name (currently
8686
`master`, but this is subject to change in the future; the name can be
8787
customized via the `init.defaultBranch` configuration variable).
8888

89-
--shared[=(false|true|umask|group|all|world|everybody|<perm>)]::
89+
++--shared++[++=++(`false`|`true`|`umask`|`group`|`all`|`world`|`everybody`|_<perm>_)]::
9090

9191
Specify that the Git repository is to be shared amongst several users. This
9292
allows users belonging to the same group to push into that
9393
repository. When specified, the config variable `core.sharedRepository` is
9494
set so that files and directories under `$GIT_DIR` are created with the
9595
requested permissions. When not specified, Git will use permissions reported
96-
by `umask(2)`.
96+
by `umask`(2).
9797
+
9898
The option can have the following values, defaulting to `group` if no value
9999
is given:
100100
+
101101
--
102-
umask::
103-
false::
102+
`umask`::
103+
`false`::
104104

105-
Use permissions reported by umask(2). The default, when `--shared` is not
105+
Use permissions reported by `umask`(2). The default, when `--shared` is not
106106
specified.
107107

108-
group::
109-
true::
108+
`group`::
109+
`true`::
110110

111-
Make the repository group-writable, (and g+sx, since the git group may not be
111+
Make the repository group-writable, (and `g+sx`, since the git group may not be
112112
the primary group of all users). This is used to loosen the permissions of an
113-
otherwise safe umask(2) value. Note that the umask still applies to the other
113+
otherwise safe `umask`(2) value. Note that the umask still applies to the other
114114
permission bits (e.g. if umask is `0022`, using `group` will not remove read
115115
privileges from other (non-group) users). See `0xxx` for how to exactly specify
116116
the repository permissions.
117117

118-
all::
119-
world::
120-
everybody::
118+
`all`::
119+
`world`::
120+
`everybody`::
121121

122122
Same as `group`, but make the repository readable by all users.
123123

124-
<perm>::
124+
_<perm>_::
125125

126126
_<perm>_ is a 3-digit octal number prefixed with `0` and each file
127-
will have mode _<perm>_. _<perm>_ will override users'`umask(2)`
127+
will have mode _<perm>_. _<perm>_ will override users' `umask`(2)
128128
value (and not only loosen permissions as `group` and `all`
129129
do). `0640` will create a repository which is group-readable, but
130130
not group-writable or accessible to others. `0660` will create a repo

0 commit comments

Comments
 (0)