From 45d5ed3e50375a4b1c5d1bf49128aec975b0546d Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jean-No=C3=ABl=20Avila?= Date: Sun, 10 Mar 2024 19:10:30 +0000 Subject: [PATCH] doc: git-clone: format placeholders MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit With the new formatting rules, we use __. Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 26 +++++++++++++------------- Documentation/urls.txt | 4 ++-- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 3bd6bbb5da..639b361689 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -102,9 +102,9 @@ its source repository, you can simply run `git repack -a` to copy all objects from the source repository into a pack in the cloned repository. --reference[-if-able] :: - If the reference repository is on the local machine, + If the reference __ is on the local machine, automatically setup `.git/objects/info/alternates` to - obtain objects from the reference repository. Using + obtain objects from the reference __. Using an already existing repository as an alternate will require fewer objects to be copied from the repository being cloned, reducing network and local storage costs. @@ -161,8 +161,8 @@ objects from the source repository into a pack in the cloned repository. --bare:: Make a 'bare' Git repository. That is, instead of - creating `` and placing the administrative - files in `/.git`, make the `` + creating __ and placing the administrative + files in `/.git`, make the __ itself the `$GIT_DIR`. This obviously implies the `--no-checkout` because there is nowhere to check out the working tree. Also the branch heads at the remote are copied directly @@ -180,11 +180,11 @@ objects from the source repository into a pack in the cloned repository. --filter=:: Use the partial clone feature and request that the server sends a subset of reachable objects according to a given object filter. - When using `--filter`, the supplied `` is used for + When using `--filter`, the supplied __ is used for the partial clone filter. For example, `--filter=blob:none` will filter out all blobs (file contents) until needed by Git. Also, `--filter=blob:limit=` will filter out all blobs of size - at least ``. For more details on filter specifications, see + at least __. For more details on filter specifications, see the `--filter` option in linkgit:git-rev-list[1]. --also-filter-submodules:: @@ -203,13 +203,13 @@ objects from the source repository into a pack in the cloned repository. -o :: --origin :: Instead of using the remote name `origin` to keep track of the upstream - repository, use ``. Overrides `clone.defaultRemoteName` from the + repository, use __. Overrides `clone.defaultRemoteName` from the config. -b :: --branch :: Instead of pointing the newly created HEAD to the branch pointed - to by the cloned repository's HEAD, point to `` branch + to by the cloned repository's HEAD, point to __ branch instead. In a non-bare repository, this is the branch that will be checked out. `--branch` can also take tags and detaches the HEAD at that commit @@ -230,7 +230,7 @@ objects from the source repository into a pack in the cloned repository. Set a configuration variable in the newly-created repository; this takes effect immediately after the repository is initialized, but before the remote history is fetched or any - files checked out. The key is in the same format as expected by + files checked out. The __ is in the same format as expected by linkgit:git-config[1] (e.g., `core.eol=true`). If multiple values are given for the same key, each value will be written to the config file. This makes it safe, for example, to add @@ -281,7 +281,7 @@ branch of some repository for search indexing. --recurse-submodules[=]:: After the clone is created, initialize and clone submodules - within based on the provided pathspec. If no pathspec is + within based on the provided __. If no _=_ is provided, all submodules are initialized and cloned. This option can be given multiple times for pathspecs consisting of multiple entries. The resulting clone has `submodule.active` set to @@ -323,20 +323,20 @@ include::ref-storage-format.txt[] Defaults to the `submodule.fetchJobs` option. :: - The (possibly remote) repository to clone from. See the + The (possibly remote) __ to clone from. See the <> section below for more information on specifying repositories. :: The name of a new directory to clone into. The "humanish" - part of the source repository is used if no directory is + part of the source repository is used if no __ is explicitly given (`repo` for `/path/to/repo.git` and `foo` for `host.xz:foo/.git`). Cloning into an existing directory is only allowed if the directory is empty. --bundle-uri=:: Before fetching from the remote, fetch a bundle from the given - `` and unbundle the data into the local repository. The refs + __ and unbundle the data into the local repository. The refs in the bundle will be stored under the hidden `refs/bundle/*` namespace. This option is incompatible with `--depth`, `--shallow-since`, and `--shallow-exclude`. diff --git a/Documentation/urls.txt b/Documentation/urls.txt index 9af19be207..0b9e0c4302 100644 --- a/Documentation/urls.txt +++ b/Documentation/urls.txt @@ -61,9 +61,9 @@ attempts to use the `remote-` remote helper, if one exists. To explicitly request a remote helper, the following syntax may be used: -- ::
+- __::_
_ -where
may be a path, a server and path, or an arbitrary +where _
_ may be a path, a server and path, or an arbitrary URL-like string recognized by the specific remote helper being invoked. See linkgit:gitremote-helpers[7] for details. -- 2.11.4.GIT