@matheusbsbs / matheus-bagliano / commits / 2261d81490

doc: git-init: format verbatim parts

Verbatim parts are all formatted as `fixed font`. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jean-Noël Avila committed Mar 10, 2024 at 19:10 UTC 2261d81490c0d3a676b8cadf629bbb3cf0643cf3
1 file changed +16 -16
Documentation/git-init.txt
+16 -16
@@ -33,10 +33,10 @@ If the object storage directory is specified via the
33 are created underneath; otherwise, the default `$GIT_DIR/objects`
34 directory is used.
35
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
37 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).
40
41 OPTIONS
42 -------
@@ -53,8 +53,8 @@ current working directory.
53
54 --object-format=<format>::
55
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.
58 +
59 include::object-format-disclaimer.txt[]
60
@@ -90,12 +90,12 @@ customized via the `init.defaultBranch` configuration variable).
90
91 Specify that the Git repository is to be shared amongst several users. This
92 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
94 set so that files and directories under `$GIT_DIR` are created with the
95 requested permissions. When not specified, Git will use permissions reported
96 -by umask(2).
96 +by `umask(2)`.
97 +
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
99 is given:
100 +
101 --
@@ -109,21 +109,21 @@ specified.
109 Make the repository group-writable, (and g+sx, since the git group may not be
110 the primary group of all users). This is used to loosen the permissions of an
111 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
114 the repository permissions.
115
116 'all' (or 'world' or 'everybody')::
117
118 -Same as 'group', but make the repository readable by all users.
118 +Same as `group`, but make the repository readable by all users.
119
120 '<perm>'::
121
122 '<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
127 that is readable and writable to the current user and group, but
128 inaccessible to others (directories and executable files get their
129 `x` bit from the `r` bit for corresponding classes of users).
@@ -172,7 +172,7 @@ $ git add . <2>
172 $ git commit <3>
173 ----------------
174 +
175 -<1> Create a /path/to/my/codebase/.git directory.
175 +<1> Create a `/path/to/my/codebase/.git` directory.
176 <2> Add all existing files to the index.
177 <3> Record the pristine state as the first commit in the history.
178