]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: git-clone: format placeholders
authorJean-Noël Avila <jn.avila@free.fr>
Sun, 10 Mar 2024 19:10:30 +0000 (19:10 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 11 Mar 2024 16:58:11 +0000 (09:58 -0700)
With the new formatting rules, we use _<placeholders>_.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-clone.txt
Documentation/urls.txt

index 3bd6bbb5da11ee09242758b5fbd8bf587a0d19c7..639b36168968d7eb3f29d1d16f65545799cf3619 100644 (file)
@@ -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] <repository>::
-       If the reference repository is on the local machine,
+       If the reference _<repository>_ is on the local machine,
        automatically setup `.git/objects/info/alternates` to
-       obtain objects from the reference repository.  Using
+       obtain objects from the reference _<repository>_.  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 `<directory>` and placing the administrative
-       files in `<directory>/.git`, make the `<directory>`
+       creating _<directory>_ and placing the administrative
+       files in `<directory>/.git`, make the _<directory>_
        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=<filter-spec>::
        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 `<filter-spec>` is used for
+       When using `--filter`, the supplied _<filter-spec>_ 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=<size>` will filter out all blobs of size
-       at least `<size>`. For more details on filter specifications, see
+       at least _<size>_. 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 <name>::
 --origin <name>::
        Instead of using the remote name `origin` to keep track of the upstream
-       repository, use `<name>`.  Overrides `clone.defaultRemoteName` from the
+       repository, use _<name>_.  Overrides `clone.defaultRemoteName` from the
        config.
 
 -b <name>::
 --branch <name>::
        Instead of pointing the newly created HEAD to the branch pointed
-       to by the cloned repository's HEAD, point to `<name>` branch
+       to by the cloned repository's HEAD, point to _<name>_ 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 _<key>_ 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[=<pathspec>]::
        After the clone is created, initialize and clone submodules
-       within based on the provided pathspec.  If no pathspec is
+       within based on the provided _<pathspec>_.  If no _=<pathspec>_ 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.
 
 <repository>::
-       The (possibly remote) repository to clone from.  See the
+       The (possibly remote) _<repository>_ to clone from.  See the
        <<URLS,GIT URLS>> section below for more information on specifying
        repositories.
 
 <directory>::
        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 _<directory>_ 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=<uri>::
        Before fetching from the remote, fetch a bundle from the given
-       `<uri>` and unbundle the data into the local repository. The refs
+       _<uri>_ 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`.
index 9af19be2075c61281fd580eae926d168dc37708d..0b9e0c4302d850a7a38044d03bd1146764bc83ca 100644 (file)
@@ -61,9 +61,9 @@ attempts to use the `remote-<transport>` remote helper, if one
 exists. To explicitly request a remote helper, the following syntax
 may be used:
 
-- <transport>::<address>
+- _<transport>_::_<address>_
 
-where <address> may be a path, a server and path, or an arbitrary
+where _<address>_ 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.