git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 2/6] doc: git-init: format placeholders

From
Jean-Noël Avila via GitGitGadget <gitgitgadget@gmail.com>
Date
Mar 10, 2024, 19:10 UTC
Message-ID
<df95ca4b720a86ad5c80e1a8a8cefe9abd0275b2.1710097830.git.gitgitgadget@gmail.com>
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
Previous: Jean-Noël Avila via GitGitGadgetNext: Jean-Noël Avila via GitGitGadget
Message 3 of 9 in “doc: rework doc files for git-init and git-clone”
  1. 0/6 doc: rework doc files for git-init and git-cloneJean-Noël Avila via GitGitGadget, Mar 10, 2024
  2. 1/6 doc: git-init: format verbatim partsJean-Noël Avila via GitGitGadget, Mar 10, 2024
  3. 2/6 doc: git-init: format placeholdersJean-Noël Avila via GitGitGadget, Mar 10, 2024
  4. 3/6 doc: git-init: rework definition listsJean-Noël Avila via GitGitGadget, Mar 10, 2024
  5. 4/6 doc: git-init: rework config item init.templateDirJean-Noël Avila via GitGitGadget, Mar 10, 2024
  6. 5/6 doc: git-clone: format verbatim wordsJean-Noël Avila via GitGitGadget, Mar 10, 2024
  7. 6/6 doc: git-clone: format placeholdersJean-Noël Avila via GitGitGadget, Mar 10, 2024
  8. Junio C HamanoMar 11, 2024
  9. Jean-Noël AvilaMar 11, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.