Skip to content

Commit 2261d81

Browse files
jnavilagitster
authored andcommitted
doc: git-init: format verbatim parts
Verbatim parts are all formatted as `fixed font`. Signed-off-by: Jean-Noël Avila <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 3c2a3fd commit 2261d81

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

Documentation/git-init.txt

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ If the object storage directory is specified via the
3333
are created underneath; otherwise, the default `$GIT_DIR/objects`
3434
directory is used.
3535

36-
Running 'git init' in an existing repository is safe. It will not
36+
Running `git init` in an existing repository is safe. It will not
3737
overwrite things that are already there. The primary reason for
38-
rerunning 'git init' is to pick up newly added templates (or to move
39-
the repository to another place if --separate-git-dir is given).
38+
rerunning `git init` is to pick up newly added templates (or to move
39+
the repository to another place if `--separate-git-dir` is given).
4040

4141
OPTIONS
4242
-------
@@ -53,8 +53,8 @@ current working directory.
5353

5454
--object-format=<format>::
5555

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

@@ -90,12 +90,12 @@ customized via the `init.defaultBranch` configuration variable).
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
93-
repository. When specified, the config variable "core.sharedRepository" is
93+
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
+
98-
The option can have the following values, defaulting to 'group' if no value
98+
The option can have the following values, defaulting to `group` if no value
9999
is given:
100100
+
101101
--
@@ -109,21 +109,21 @@ specified.
109109
Make the repository group-writable, (and g+sx, since the git group may not be
110110
the primary group of all users). This is used to loosen the permissions of an
111111
otherwise safe umask(2) value. Note that the umask still applies to the other
112-
permission bits (e.g. if umask is '0022', using 'group' will not remove read
113-
privileges from other (non-group) users). See '0xxx' for how to exactly specify
112+
permission bits (e.g. if umask is `0022`, using `group` will not remove read
113+
privileges from other (non-group) users). See `0xxx` for how to exactly specify
114114
the repository permissions.
115115

116116
'all' (or 'world' or 'everybody')::
117117

118-
Same as 'group', but make the repository readable by all users.
118+
Same as `group`, but make the repository readable by all users.
119119

120120
'<perm>'::
121121

122122
'<perm>' is a 3-digit octal number prefixed with `0` and each file
123-
will have mode '<perm>'. '<perm>' will override users' umask(2)
124-
value (and not only loosen permissions as 'group' and 'all'
125-
do). '0640' will create a repository which is group-readable, but
126-
not group-writable or accessible to others. '0660' will create a repo
123+
will have mode '<perm>'. '<perm>' will override users'`umask(2)`
124+
value (and not only loosen permissions as `group` and `all`
125+
do). `0640` will create a repository which is group-readable, but
126+
not group-writable or accessible to others. `0660` will create a repo
127127
that is readable and writable to the current user and group, but
128128
inaccessible to others (directories and executable files get their
129129
`x` bit from the `r` bit for corresponding classes of users).
@@ -172,7 +172,7 @@ $ git add . <2>
172172
$ git commit <3>
173173
----------------
174174
+
175-
<1> Create a /path/to/my/codebase/.git directory.
175+
<1> Create a `/path/to/my/codebase/.git` directory.
176176
<2> Add all existing files to the index.
177177
<3> Record the pristine state as the first commit in the history.
178178

0 commit comments

Comments
 (0)