[PATCH v2 0/2] Update git-clone doc: refer to long form of the options and list short form of the options first
To make doc of git-clone easier to read, refer to the long version of the options (it is easier to guess what --verbose is doing than -v).
Also: put the short options first, to match the doc of git-add, git-commit,
git-clean, git-branch...
Quentin Nerden (2):
docs: git-clone: refer to long form of options
docs: git-clone: list short form of options first
Documentation/git-clone.txt | 34 +++++++++++++++++-----------------
1 file changed, 17 insertions(+), 17 deletions(-)
base-commit: 8dca754b1e874719a732bc9ab7b0e14b21b1bc10
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-277%2Fkenden%2Fpatch-1-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-277/kenden/patch-1-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/277
Range-diff vs v1:
-: ---------- > 1: d2f5540ea1 docs: git-clone: refer to long form of options
1: 0dd1b01769 ! 2: c562cf681f docs: update git-clone doc: refer to long options
@@ -1,13 +1,10 @@
-Author: Quentin Nerden <quentin.nerden@gmail.com>
+Author: Quentin Nerden <quentin.nerden@intel.com>
- docs: update git-clone doc: refer to long options
+ docs: git-clone: list short form of options first
- To make the doc of git-clone easier to read,
- refer to the long version of the options
- (it is easier to guess what --verbose is doing than -v).
-
- Also:
- put the short options first, to match the doc of git-add, git-commit, git-clean, git-branch...
+ List the short form of options (e.g.: '-l') before the long form (e.g.
+ '--local').
+ This is to match the doc of git-add, git-commit, git-clean, git-branch...
Signed-off-by: Quentin Nerden <quentin.nerden@gmail.com>
@@ -34,19 +31,6 @@
When the repository to clone is on the local machine,
instead of using hard links, automatically setup
`.git/objects/info/alternates` to share the objects
-@@
- If these objects are removed and were referenced by the cloned repository,
- then the cloned repository will become corrupt.
- +
--Note that running `git repack` without the `-l` option in a repository
-+Note that running `git repack` without the `--local` option in a repository
- cloned with `-s` will copy objects from the source repository into a pack
- in the cloned repository, removing the disk space savings of `clone -s`.
--It is safe, however, to run `git gc`, which uses the `-l` option by
-+It is safe, however, to run `git gc`, which uses the `--local` option by
- default.
- +
- If you want to break the dependency of a repository cloned with `-s` on
@@
same repository, and this option can be used to stop the
borrowing.
@@ -63,13 +47,6 @@
Run verbosely. Does not affect the reporting of progress status
to the standard error stream.
- --progress::
- Progress status is reported on the standard error stream
-- by default when it is attached to a terminal, unless -q
-+ by default when it is attached to a terminal, unless `--quiet`
- is specified. This flag forces progress status even if the
- standard error stream is not directed to a terminal.
-
@@
When multiple `--server-option=<option>` are given, they are all
sent to the other side in the order listed on the command line.
@@ -80,14 +57,6 @@
No checkout of HEAD is performed after the clone is complete.
--bare::
- Make a 'bare' Git repository. That is, instead of
- creating `<directory>` and placing the administrative
- files in `<directory>/.git`, make the `<directory>`
-- itself the `$GIT_DIR`. This obviously implies the `-n`
-+ itself the `$GIT_DIR`. This obviously implies `--no-checkout`
- because there is nowhere to check out the working tree.
- Also the branch heads at the remote are copied directly
- to corresponding local branch heads, without mapping
@@
that all these refs are overwritten by a `git remote update` in the
target repository.
@@ -124,13 +93,3 @@
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
-@@
- The result is Git repository can be separated from working
- tree.
-
---j <n>::
- --jobs <n>::
-+-j <n>::
- The number of submodules fetched at the same time.
- Defaults to the `submodule.fetchJobs` option.
- 
