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

[PATCH 5/6] doc: git-clone: format verbatim words

From
Jean-Noël Avila via GitGitGadget <gitgitgadget@gmail.com>
Date
Mar 10, 2024, 19:10 UTC
Message-ID
<54e5d8735c4351e5041f777f8d9da0fcadfcfef6.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>
We also apply the formatting to urls.txt which is included.
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
---
 Documentation/git-clone.txt | 4 ++--
 Documentation/urls.txt      | 8 ++++----
 2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 0c07720c6f4..6bad5641151 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -156,7 +156,7 @@ objects from the source repository into a pack in the cloned repository.
 
 --[no-]reject-shallow::
 	Fail if the source repository is a shallow repository.
-	The 'clone.rejectShallow' configuration variable can be used to
+	The `clone.rejectShallow` configuration variable can be used to
 	specify the default.
 
 --bare::
@@ -263,7 +263,7 @@ corresponding `--mirror` and `--no-tags` options instead.
 	branch remote's `HEAD` points at.
 	Further fetches into the resulting repository will only update the
 	remote-tracking branch for the branch this option was used for the
-	initial cloning.  If the HEAD at the remote did not point at any
+	initial cloning.  If the `HEAD` at the remote did not point at any
 	branch when `--single-branch` clone was made, no remote-tracking
 	branch is created.
 
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index ce671f812d4..9af19be2075 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -44,20 +44,20 @@ syntaxes may be used:
 
 ifndef::git-clone[]
 These two syntaxes are mostly equivalent, except when cloning, when
-the former implies --local option. See linkgit:git-clone[1] for
+the former implies `--local` option. See linkgit:git-clone[1] for
 details.
 endif::git-clone[]
 
 ifdef::git-clone[]
 These two syntaxes are mostly equivalent, except the former implies
---local option.
+`--local` option.
 endif::git-clone[]
 
-'git clone', 'git fetch' and 'git pull', but not 'git push', will also
+`git clone`, `git fetch` and `git pull`, but not `git push`, will also
 accept a suitable bundle file. See linkgit:git-bundle[1].
 
 When Git doesn't know how to handle a certain transport protocol, it
-attempts to use the 'remote-<transport>' remote helper, if one
+attempts to use the `remote-<transport>` remote helper, if one
 exists. To explicitly request a remote helper, the following syntax
 may be used:
 
-- 
gitgitgadget
Previous: Jean-Noël Avila via GitGitGadgetNext: Jean-Noël Avila via GitGitGadget
Message 6 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.