git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Jean-Noël Avila" <jn.avila@free.fr>,
	"Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH 2/6] doc: git-init: format placeholders
Date: Sun, 10 Mar 2024 19:10:26 +0000	[thread overview]
Message-ID: <df95ca4b720a86ad5c80e1a8a8cefe9abd0275b2.1710097830.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1687.git.1710097830.gitgitgadget@gmail.com>

From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>

With the new doc format conventions, we use _<placeholders>_.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
---
 Documentation/git-init.txt | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index 7ff7d8e7ee0..e8fe72861dc 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -60,7 +60,7 @@ include::object-format-disclaimer.txt[]
 
 --ref-format=<format>::
 
-Specify the given ref storage format for the repository. The valid values are:
+Specify the given ref storage _<format>_ for the repository. The valid values are:
 +
 include::ref-storage-format.txt[]
 
@@ -81,7 +81,7 @@ If this is a reinitialization, the repository will be moved to the specified pat
 -b <branch-name>::
 --initial-branch=<branch-name>::
 
-Use the specified name for the initial branch in the newly created
+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).
@@ -119,8 +119,8 @@ Same as `group`, but make the repository readable by all users.
 
 '<perm>'::
 
-'<perm>' is a 3-digit octal number prefixed with `0` and each file
-will have mode '<perm>'. '<perm>' will override users'`umask(2)`
+_<perm>_ is a 3-digit octal number prefixed with `0` and each file
+will have mode _<perm>_. _<perm>_ will override users'`umask(2)`
 value (and not only loosen permissions as `group` and `all`
 do). `0640` will create a repository which is group-readable, but
 not group-writable or accessible to others. `0660` will create a repo
@@ -133,7 +133,7 @@ By default, the configuration flag `receive.denyNonFastForwards` is enabled
 in shared repositories, so that you cannot force a non fast-forwarding push
 into it.
 
-If you provide a 'directory', the command is run inside it. If this directory
+If you provide a _<directory>_, the command is run inside it. If this directory
 does not exist, it will be created.
 
 TEMPLATE DIRECTORY
-- 
gitgitgadget



  parent reply	other threads:[~2024-03-10 19:10 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-10 19:10 [PATCH 0/6] doc: rework doc files for git-init and git-clone Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` [PATCH 1/6] doc: git-init: format verbatim parts Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` Jean-Noël Avila via GitGitGadget [this message]
2024-03-10 19:10 ` [PATCH 3/6] doc: git-init: rework definition lists Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` [PATCH 4/6] doc: git-init: rework config item init.templateDir Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` [PATCH 5/6] doc: git-clone: format verbatim words Jean-Noël Avila via GitGitGadget
2024-03-10 19:10 ` [PATCH 6/6] doc: git-clone: format placeholders Jean-Noël Avila via GitGitGadget
2024-03-11 17:05   ` Junio C Hamano
2024-03-11 21:43     ` Jean-Noël Avila

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=df95ca4b720a86ad5c80e1a8a8cefe9abd0275b2.1710097830.git.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=jn.avila@free.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).