diff mbox series

[3/4] doc: git-init: apply new documentation formatting guidelines

Message ID 310f09fc81c75ef03eb00629db6302d1904585fe.1711318740.git.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series Doc new guidelines | expand

Commit Message

Jean-Noël Avila March 24, 2024, 10:18 p.m. UTC 
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
---
 Documentation/config/init.txt |  4 +--
 Documentation/git-init.txt    | 46 +++++++++++++++++------------------
 2 files changed, 25 insertions(+), 25 deletions(-)

Comments

Martin Ågren March 26, 2024, 8:18 p.m. UTC | #1 
On Sun, 24 Mar 2024 at 23:19, Jean-Noël Avila via GitGitGadget
<gitgitgadget@gmail.com> wrote:
> -umask::
> -false::
> +`umask`::
> +`false`::

(It should be `umask` here exactly as you did, ok, good.)

>  Use permissions reported by umask(2). The default, when `--shared` is not
>  specified.

>  _<perm>_ is a 3-digit octal number prefixed with `0` and each file
>  will have mode _<perm>_. _<perm>_ will override users'`umask(2)`

It's a bit of a mix whether umask(2) should be `umask(2)` with backticks
or just umask(2) without. That's pretty much the only thing I noticed,
everything else looks really nice and consistent. I guess it's not a
literal, since we don't expect to user to actually type the 8 characters
"umask(2)"? If you do decide to drop the backticks, notice that there's
one instance (seen above) of "users'`umask(2)`" with a missing space,
so you might want to fix that up at the same time.

Martin
Jean-Noël Avila March 26, 2024, 8:26 p.m. UTC | #2 
Le mardi 26 mars 2024, 21:18:31 CET Martin Ågren a écrit :
> On Sun, 24 Mar 2024 at 23:19, Jean-Noël Avila via GitGitGadget
> <gitgitgadget@gmail.com> wrote:
> > -umask::
> > -false::
> > +`umask`::
> > +`false`::
> 
> (It should be `umask` here exactly as you did, ok, good.)
> 
> >  Use permissions reported by umask(2). The default, when `--shared` is not
> >  specified.
> 
> >  _<perm>_ is a 3-digit octal number prefixed with `0` and each file
> >  will have mode _<perm>_. _<perm>_ will override users'`umask(2)`
> 
> It's a bit of a mix whether umask(2) should be `umask(2)` with backticks
> or just umask(2) without. That's pretty much the only thing I noticed,
> everything else looks really nice and consistent. I guess it's not a
> literal, since we don't expect to user to actually type the 8 characters
> "umask(2)"? If you do decide to drop the backticks, notice that there's
> one instance (seen above) of "users'`umask(2)`" with a missing space,
> so you might want to fix that up at the same time.
> 
> Martin
> 

Ah. Good point! As we are referring to the manpage of a function, this *is* 
indeed a case of verbatim text so, it must be backquoted. 

So, I'll add it the guidelines and reroll with changes in the man pages.

Thanks
diff mbox series

Patch

diff --git a/Documentation/config/init.txt b/Documentation/config/init.txt
index dd1d8332737..af03acdbcbb 100644
--- a/Documentation/config/init.txt
+++ b/Documentation/config/init.txt
@@ -3,8 +3,8 @@  ifndef::git-init[]
 :see-git-init: (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
 endif::[]
 
-init.templateDir::
+`init.templateDir`::
 	Specify the directory from which templates will be copied. {see-git-init}
-init.defaultBranch::
+`init.defaultBranch`::
 	Allows overriding the default branch name e.g. when initializing
 	a new repository.
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index 2f864e11ed9..ac4c4a80e26 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -9,11 +9,11 @@  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>]
-	  [--ref-format=<format>]
-	  [-b <branch-name> | --initial-branch=<branch-name>]
-	  [--shared[=<permissions>]] [<directory>]
+`git init` [`-q` | `--quiet`] [`--bare`] [`--template=`{empty}__<template-directory>__]
+	  [`--separate-git-dir` _<git-dir>_] [`--object-format=`{empty}__<format>__]
+	  [`--ref-format=`{empty}__<format>__]
+	  [`-b` _<branch-name>_ | `--initial-branch=`{empty}__<branch-name>__]
+	  [`--shared`[`=`{empty}__<permissions>__]] [_<directory>_]
 
 
 DESCRIPTION
@@ -41,35 +41,35 @@  the repository to another place if `--separate-git-dir` is given).
 OPTIONS
 -------
 
--q::
---quiet::
+`-q`::
+`--quiet`::
 
 Only print error and warning messages; all other output will be suppressed.
 
---bare::
+`--bare`::
 
 Create a bare repository. If `GIT_DIR` environment is not set, it is set to the
 current working directory.
 
---object-format=<format>::
+`--object-format=`{empty}__<format>__::
 
 Specify the given object _<format>_ (hash algorithm) for the repository.  The valid
 values are `sha1` and (if enabled) `sha256`.  `sha1` is the default.
 +
 include::object-format-disclaimer.txt[]
 
---ref-format=<format>::
+`--ref-format=`{empty}__<format>__::
 
 Specify the given ref storage _<format>_ for the repository. The valid values are:
 +
 include::ref-storage-format.txt[]
 
---template=<template-directory>::
+`--template=`{empty}__<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=`{empty}__<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
@@ -78,15 +78,15 @@  repository.
 +
 If this is a reinitialization, the repository will be moved to the specified path.
 
--b <branch-name>::
---initial-branch=<branch-name>::
+`-b` _<branch-name>_::
+`--initial-branch=`{empty}__<branch-name>__::
 
 Use _<branch-name>_ for the initial branch in the newly created
 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|<perm>)]::
+`--shared`[`=`(`false`|`true`|`umask`|`group`|`all`|`world`|`everybody`|_<perm>_)]::
 
 Specify that the Git repository is to be shared amongst several users.  This
 allows users belonging to the same group to push into that
@@ -99,14 +99,14 @@  The option can have the following values, defaulting to `group` if no value
 is given:
 +
 --
-umask::
-false::
+`umask`::
+`false`::
 
 Use permissions reported by umask(2). The default, when `--shared` is not
 specified.
 
-group::
-true::
+`group`::
+`true`::
 
 Make the repository group-writable, (and g+sx, since the git group may not be
 the primary group of all users). This is used to loosen the permissions of an
@@ -115,13 +115,13 @@  permission bits (e.g. if umask is `0022`, using `group` will not remove read
 privileges from other (non-group) users). See `0xxx` for how to exactly specify
 the repository permissions.
 
-all::
-world::
-everybody::
+`all`::
+`world`::
+`everybody`::
 
 Same as `group`, but make the repository readable by all users.
 
-<perm>::
+_<perm>_::
 
 _<perm>_ is a 3-digit octal number prefixed with `0` and each file
 will have mode _<perm>_. _<perm>_ will override users'`umask(2)`