{"thread":{"id":"51397","subject":"[PATCH 0/1] Update git-clone doc: refer to long option","startedAt":"2019-06-27T19:17:03Z","lastAt":"2019-07-02T19:14:25Z","messageCount":8,"participants":["Quentin Nerden via GitGitGadget","Junio C Hamano","Johannes Schindelin"],"isPatch":true,"patchVersion":1,"patchTotal":1},"messages":[{"id":"378191","messageId":"pull.277.git.gitgitgadget@gmail.com","threadId":"51397","inReplyTo":null,"subject":"[PATCH 0/1] Update git-clone doc: refer to long option","fromName":"Quentin Nerden via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-06-27T19:16:59Z","receivedAt":"2019-06-27T19:17:03Z","isPatch":true,"sender":{"key":"name:Quentin Nerden","avatar":null},"body":"To make doc of git-clone easier to read, refer to the long version of the\noptions (it is easier to guess what --verbose is doing than -v).\n\nAlso: put the short options first, to match the doc of git-add, git-commit,\ngit-clean, git-branch...\n\nQuentin Nerden (1):\n  docs: update git-clone doc: refer to long options\n\n Documentation/git-clone.txt | 28 ++++++++++++++--------------\n 1 file changed, 14 insertions(+), 14 deletions(-)\n\n\nbase-commit: 8dca754b1e874719a732bc9ab7b0e14b21b1bc10\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-277%2Fkenden%2Fpatch-1-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-277/kenden/patch-1-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/277\n-- \ngitgitgadget\n"},{"id":"378192","messageId":"0dd1b017698dd9d15f291f1133eb40dac8d85a68.1561663019.git.gitgitgadget@gmail.com","threadId":"51397","inReplyTo":"pull.277.git.gitgitgadget@gmail.com","subject":"[PATCH 1/1] docs: update git-clone doc: refer to long options","fromName":"Quentin Nerden via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-06-27T19:17:00Z","receivedAt":"2019-06-27T19:17:04Z","isPatch":true,"sender":{"key":"name:Quentin Nerden","avatar":null},"body":"From: Quentin Nerden <quentin.nerden@gmail.com>\n\nTo make the doc of git-clone easier to read,\nrefer to the long version of the options\n(it is easier to guess what --verbose is doing than -v).\n\nAlso:\nput the short options first, to match the doc of git-add, git-commit, git-clean, git-branch...\n\nSigned-off-by: Quentin Nerden <quentin.nerden@gmail.com>\n---\n Documentation/git-clone.txt | 28 ++++++++++++++--------------\n 1 file changed, 14 insertions(+), 14 deletions(-)\n\ndiff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt\nindex 5fc97f14de..4edc713a4b 100644\n--- a/Documentation/git-clone.txt\n+++ b/Documentation/git-clone.txt\n@@ -41,8 +41,8 @@ configuration variables.\n \n OPTIONS\n -------\n---local::\n -l::\n+--local::\n \tWhen the repository to clone from is on a local machine,\n \tthis flag bypasses the normal \"Git aware\" transport\n \tmechanism and clones the repository by making a copy of\n@@ -63,8 +63,8 @@ Git transport instead.\n \tdirectory instead of using hardlinks. This may be desirable\n \tif you are trying to make a back-up of your repository.\n \n---shared::\n -s::\n+--shared::\n \tWhen the repository to clone is on the local machine,\n \tinstead of using hard links, automatically setup\n \t`.git/objects/info/alternates` to share the objects\n@@ -81,10 +81,10 @@ which automatically call `git gc --auto`. (See linkgit:git-gc[1].)\n If these objects are removed and were referenced by the cloned repository,\n then the cloned repository will become corrupt.\n +\n-Note that running `git repack` without the `-l` option in a repository\n+Note that running `git repack` without the `--local` option in a repository\n cloned with `-s` will copy objects from the source repository into a pack\n in the cloned repository, removing the disk space savings of `clone -s`.\n-It is safe, however, to run `git gc`, which uses the `-l` option by\n+It is safe, however, to run `git gc`, which uses the `--local` option by\n default.\n +\n If you want to break the dependency of a repository cloned with `-s` on\n@@ -116,19 +116,19 @@ objects from the source repository into a pack in the cloned repository.\n \tsame repository, and this option can be used to stop the\n \tborrowing.\n \n---quiet::\n -q::\n+--quiet::\n \tOperate quietly.  Progress is not reported to the standard\n \terror stream.\n \n---verbose::\n -v::\n+--verbose::\n \tRun verbosely. Does not affect the reporting of progress status\n \tto the standard error stream.\n \n --progress::\n \tProgress status is reported on the standard error stream\n-\tby default when it is attached to a terminal, unless -q\n+\tby default when it is attached to a terminal, unless `--quiet`\n \tis specified. This flag forces progress status even if the\n \tstandard error stream is not directed to a terminal.\n \n@@ -140,15 +140,15 @@ objects from the source repository into a pack in the cloned repository.\n \tWhen multiple `--server-option=<option>` are given, they are all\n \tsent to the other side in the order listed on the command line.\n \n---no-checkout::\n -n::\n+--no-checkout::\n \tNo checkout of HEAD is performed after the clone is complete.\n \n --bare::\n \tMake a 'bare' Git repository.  That is, instead of\n \tcreating `<directory>` and placing the administrative\n \tfiles in `<directory>/.git`, make the `<directory>`\n-\titself the `$GIT_DIR`. This obviously implies the `-n`\n+\titself the `$GIT_DIR`. This obviously implies `--no-checkout`\n \tbecause there is nowhere to check out the working tree.\n \tAlso the branch heads at the remote are copied directly\n \tto corresponding local branch heads, without mapping\n@@ -164,13 +164,13 @@ objects from the source repository into a pack in the cloned repository.\n \tthat all these refs are overwritten by a `git remote update` in the\n \ttarget repository.\n \n---origin <name>::\n -o <name>::\n+--origin <name>::\n \tInstead of using the remote name `origin` to keep track\n \tof the upstream repository, use `<name>`.\n \n---branch <name>::\n -b <name>::\n+--branch <name>::\n \tInstead of pointing the newly created HEAD to the branch pointed\n \tto by the cloned repository's HEAD, point to `<name>` branch\n \tinstead. In a non-bare repository, this is the branch that will\n@@ -178,8 +178,8 @@ objects from the source repository into a pack in the cloned repository.\n \t`--branch` can also take tags and detaches the HEAD at that commit\n \tin the resulting repository.\n \n---upload-pack <upload-pack>::\n -u <upload-pack>::\n+--upload-pack <upload-pack>::\n \tWhen given, and the repository to clone from is accessed\n \tvia ssh, this specifies a non-default path for the command\n \trun on the other end.\n@@ -188,8 +188,8 @@ objects from the source repository into a pack in the cloned repository.\n \tSpecify the directory from which templates will be used;\n \t(See the \"TEMPLATE DIRECTORY\" section of linkgit:git-init[1].)\n \n---config <key>=<value>::\n -c <key>=<value>::\n+--config <key>=<value>::\n \tSet a configuration variable in the newly-created repository;\n \tthis takes effect immediately after the repository is\n \tinitialized, but before the remote history is fetched or any\n@@ -274,8 +274,8 @@ or `--mirror` is given)\n \tThe result is Git repository can be separated from working\n \ttree.\n \n--j <n>::\n --jobs <n>::\n+-j <n>::\n \tThe number of submodules fetched at the same time.\n \tDefaults to the `submodule.fetchJobs` option.\n \n-- \ngitgitgadget\n"},{"id":"378196","messageId":"xmqqmui2aiwk.fsf@gitster-ct.c.googlers.com","threadId":"51397","inReplyTo":"0dd1b017698dd9d15f291f1133eb40dac8d85a68.1561663019.git.gitgitgadget@gmail.com","subject":"Re: [PATCH 1/1] docs: update git-clone doc: refer to long options","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-06-27T20:10:51Z","receivedAt":"2019-06-27T20:11:00Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Quentin Nerden via GitGitGadget\" <gitgitgadget@gmail.com> writes:\n\n> From: Quentin Nerden <quentin.nerden@gmail.com>\n>\n> To make the doc of git-clone easier to read,\n> refer to the long version of the options\n> (it is easier to guess what --verbose is doing than -v).\n>\n> Also:\n> put the short options first, to match the doc of git-add, git-commit, git-clean, git-branch...\n\nThis \"also\" makes the patch unnecessarily harder to review.\nSplitting it into two patches would make it reviewable.\n\nThanks.\n\n>\n> Signed-off-by: Quentin Nerden <quentin.nerden@gmail.com>\n> ---\n>  Documentation/git-clone.txt | 28 ++++++++++++++--------------\n>  1 file changed, 14 insertions(+), 14 deletions(-)\n>\n> diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt\n> index 5fc97f14de..4edc713a4b 100644\n> --- a/Documentation/git-clone.txt\n> +++ b/Documentation/git-clone.txt\n> @@ -41,8 +41,8 @@ configuration variables.\n>  \n>  OPTIONS\n>  -------\n> ---local::\n>  -l::\n> +--local::\n>  \tWhen the repository to clone from is on a local machine,\n>  \tthis flag bypasses the normal \"Git aware\" transport\n>  \tmechanism and clones the repository by making a copy of\n> @@ -63,8 +63,8 @@ Git transport instead.\n>  \tdirectory instead of using hardlinks. This may be desirable\n>  \tif you are trying to make a back-up of your repository.\n>  \n> ---shared::\n>  -s::\n> +--shared::\n>  \tWhen the repository to clone is on the local machine,\n>  \tinstead of using hard links, automatically setup\n>  \t`.git/objects/info/alternates` to share the objects\n> @@ -81,10 +81,10 @@ which automatically call `git gc --auto`. (See linkgit:git-gc[1].)\n>  If these objects are removed and were referenced by the cloned repository,\n>  then the cloned repository will become corrupt.\n>  +\n> -Note that running `git repack` without the `-l` option in a repository\n> +Note that running `git repack` without the `--local` option in a repository\n>  cloned with `-s` will copy objects from the source repository into a pack\n>  in the cloned repository, removing the disk space savings of `clone -s`.\n> -It is safe, however, to run `git gc`, which uses the `-l` option by\n> +It is safe, however, to run `git gc`, which uses the `--local` option by\n>  default.\n>  +\n>  If you want to break the dependency of a repository cloned with `-s` on\n> @@ -116,19 +116,19 @@ objects from the source repository into a pack in the cloned repository.\n>  \tsame repository, and this option can be used to stop the\n>  \tborrowing.\n>  \n> ---quiet::\n>  -q::\n> +--quiet::\n>  \tOperate quietly.  Progress is not reported to the standard\n>  \terror stream.\n>  \n> ---verbose::\n>  -v::\n> +--verbose::\n>  \tRun verbosely. Does not affect the reporting of progress status\n>  \tto the standard error stream.\n>  \n>  --progress::\n>  \tProgress status is reported on the standard error stream\n> -\tby default when it is attached to a terminal, unless -q\n> +\tby default when it is attached to a terminal, unless `--quiet`\n>  \tis specified. This flag forces progress status even if the\n>  \tstandard error stream is not directed to a terminal.\n>  \n> @@ -140,15 +140,15 @@ objects from the source repository into a pack in the cloned repository.\n>  \tWhen multiple `--server-option=<option>` are given, they are all\n>  \tsent to the other side in the order listed on the command line.\n>  \n> ---no-checkout::\n>  -n::\n> +--no-checkout::\n>  \tNo checkout of HEAD is performed after the clone is complete.\n>  \n>  --bare::\n>  \tMake a 'bare' Git repository.  That is, instead of\n>  \tcreating `<directory>` and placing the administrative\n>  \tfiles in `<directory>/.git`, make the `<directory>`\n> -\titself the `$GIT_DIR`. This obviously implies the `-n`\n> +\titself the `$GIT_DIR`. This obviously implies `--no-checkout`\n>  \tbecause there is nowhere to check out the working tree.\n>  \tAlso the branch heads at the remote are copied directly\n>  \tto corresponding local branch heads, without mapping\n> @@ -164,13 +164,13 @@ objects from the source repository into a pack in the cloned repository.\n>  \tthat all these refs are overwritten by a `git remote update` in the\n>  \ttarget repository.\n>  \n> ---origin <name>::\n>  -o <name>::\n> +--origin <name>::\n>  \tInstead of using the remote name `origin` to keep track\n>  \tof the upstream repository, use `<name>`.\n>  \n> ---branch <name>::\n>  -b <name>::\n> +--branch <name>::\n>  \tInstead of pointing the newly created HEAD to the branch pointed\n>  \tto by the cloned repository's HEAD, point to `<name>` branch\n>  \tinstead. In a non-bare repository, this is the branch that will\n> @@ -178,8 +178,8 @@ objects from the source repository into a pack in the cloned repository.\n>  \t`--branch` can also take tags and detaches the HEAD at that commit\n>  \tin the resulting repository.\n>  \n> ---upload-pack <upload-pack>::\n>  -u <upload-pack>::\n> +--upload-pack <upload-pack>::\n>  \tWhen given, and the repository to clone from is accessed\n>  \tvia ssh, this specifies a non-default path for the command\n>  \trun on the other end.\n> @@ -188,8 +188,8 @@ objects from the source repository into a pack in the cloned repository.\n>  \tSpecify the directory from which templates will be used;\n>  \t(See the \"TEMPLATE DIRECTORY\" section of linkgit:git-init[1].)\n>  \n> ---config <key>=<value>::\n>  -c <key>=<value>::\n> +--config <key>=<value>::\n>  \tSet a configuration variable in the newly-created repository;\n>  \tthis takes effect immediately after the repository is\n>  \tinitialized, but before the remote history is fetched or any\n> @@ -274,8 +274,8 @@ or `--mirror` is given)\n>  \tThe result is Git repository can be separated from working\n>  \ttree.\n>  \n> --j <n>::\n>  --jobs <n>::\n> +-j <n>::\n>  \tThe number of submodules fetched at the same time.\n>  \tDefaults to the `submodule.fetchJobs` option.\n"},{"id":"378259","messageId":"nycvar.QRO.7.76.6.1906281352230.44@tvgsbejvaqbjf.bet","threadId":"51397","inReplyTo":"xmqqmui2aiwk.fsf@gitster-ct.c.googlers.com","subject":"Re: [PATCH 1/1] docs: update git-clone doc: refer to long options","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2019-06-28T11:55:29Z","receivedAt":"2019-06-28T11:55:13Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi,\n\nOn Thu, 27 Jun 2019, Junio C Hamano wrote:\n\n> \"Quentin Nerden via GitGitGadget\" <gitgitgadget@gmail.com> writes:\n>\n> > From: Quentin Nerden <quentin.nerden@gmail.com>\n> >\n> > To make the doc of git-clone easier to read,\n> > refer to the long version of the options\n> > (it is easier to guess what --verbose is doing than -v).\n> >\n> > Also:\n> > put the short options first, to match the doc of git-add, git-commit, git-clean, git-branch...\n>\n> This \"also\" makes the patch unnecessarily harder to review.\n> Splitting it into two patches would make it reviewable.\n\nGood idea.\n\nThe easiest way I can think of would be to split by first undoing the\ncommit via `git reset --hard HEAD^` (don't worry, the commit graph is\nstill accessible via the reflog), then staging the parts of the patch that\nput the short options first: `git checkout -p HEAD@{1}`. After that is\ndone, commit with a new commit message, then get the remainder of the\nchanges via `git cherry-pick HEAD@{2}` (by now, the original commit is no\nlonger `HEAD@{1}` because a new commit has been appended to the reflog).\n\nThen force-push and submit a new iteration ;-)\n\nCiao,\nJohannes\n"},{"id":"378495","messageId":"d2f5540ea1b994a574d6ce2c300018a32d7cca73.1562078259.git.gitgitgadget@gmail.com","threadId":"51397","inReplyTo":"pull.277.v2.git.gitgitgadget@gmail.com","subject":"[PATCH v2 1/2] docs: git-clone: refer to long form of options","fromName":"Quentin Nerden via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-07-02T14:37:40Z","receivedAt":"2019-07-02T14:37:44Z","isPatch":true,"sender":{"key":"name:Quentin Nerden","avatar":null},"body":"From: Quentin Nerden <quentin.nerden@intel.com>\n\nTo make the doc of git-clone easier to read,\nrefer to the long form of the options\n(it is easier to guess what '--verbose' is doing than '-v').\n\nSigned-off-by: Quentin Nerden <quentin.nerden@gmail.com>\n---\n Documentation/git-clone.txt | 16 ++++++++--------\n 1 file changed, 8 insertions(+), 8 deletions(-)\n\ndiff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt\nindex 5fc97f14de..cb3cf7a0fb 100644\n--- a/Documentation/git-clone.txt\n+++ b/Documentation/git-clone.txt\n@@ -23,7 +23,7 @@ DESCRIPTION\n \n Clones a repository into a newly created directory, creates\n remote-tracking branches for each branch in the cloned repository\n-(visible using `git branch -r`), and creates and checks out an\n+(visible using `git branch --remotes`), and creates and checks out an\n initial branch that is forked from the cloned repository's\n currently active branch.\n \n@@ -81,13 +81,13 @@ which automatically call `git gc --auto`. (See linkgit:git-gc[1].)\n If these objects are removed and were referenced by the cloned repository,\n then the cloned repository will become corrupt.\n +\n-Note that running `git repack` without the `-l` option in a repository\n-cloned with `-s` will copy objects from the source repository into a pack\n-in the cloned repository, removing the disk space savings of `clone -s`.\n-It is safe, however, to run `git gc`, which uses the `-l` option by\n+Note that running `git repack` without the `--local` option in a repository\n+cloned with `--shared` will copy objects from the source repository into a pack\n+in the cloned repository, removing the disk space savings of `clone --shared`.\n+It is safe, however, to run `git gc`, which uses the `--local` option by\n default.\n +\n-If you want to break the dependency of a repository cloned with `-s` on\n+If you want to break the dependency of a repository cloned with `--shared` on\n its source repository, you can simply run `git repack -a` to copy all\n objects from the source repository into a pack in the cloned repository.\n \n@@ -128,7 +128,7 @@ objects from the source repository into a pack in the cloned repository.\n \n --progress::\n \tProgress status is reported on the standard error stream\n-\tby default when it is attached to a terminal, unless -q\n+\tby default when it is attached to a terminal, unless `--quiet`\n \tis specified. This flag forces progress status even if the\n \tstandard error stream is not directed to a terminal.\n \n@@ -148,7 +148,7 @@ objects from the source repository into a pack in the cloned repository.\n \tMake a 'bare' Git repository.  That is, instead of\n \tcreating `<directory>` and placing the administrative\n \tfiles in `<directory>/.git`, make the `<directory>`\n-\titself the `$GIT_DIR`. This obviously implies the `-n`\n+\titself the `$GIT_DIR`. This obviously implies the `--no-checkout`\n \tbecause there is nowhere to check out the working tree.\n \tAlso the branch heads at the remote are copied directly\n \tto corresponding local branch heads, without mapping\n-- \ngitgitgadget\n\n"},{"id":"378497","messageId":"c562cf681f5c1c47cd77eead30ec9ae1eb7ca9e0.1562078259.git.gitgitgadget@gmail.com","threadId":"51397","inReplyTo":"pull.277.v2.git.gitgitgadget@gmail.com","subject":"[PATCH v2 2/2] docs: git-clone: list short form of options first","fromName":"Quentin Nerden via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-07-02T14:37:41Z","receivedAt":"2019-07-02T14:37:44Z","isPatch":true,"sender":{"key":"name:Quentin Nerden","avatar":null},"body":"From: Quentin Nerden <quentin.nerden@intel.com>\n\nList the short form of options (e.g.: '-l') before the long form (e.g.\n'--local').\nThis is to match the doc of git-add, git-commit, git-clean, git-branch...\n\nSigned-off-by: Quentin Nerden <quentin.nerden@gmail.com>\n---\n Documentation/git-clone.txt | 18 +++++++++---------\n 1 file changed, 9 insertions(+), 9 deletions(-)\n\ndiff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt\nindex cb3cf7a0fb..34011c2940 100644\n--- a/Documentation/git-clone.txt\n+++ b/Documentation/git-clone.txt\n@@ -41,8 +41,8 @@ configuration variables.\n \n OPTIONS\n -------\n---local::\n -l::\n+--local::\n \tWhen the repository to clone from is on a local machine,\n \tthis flag bypasses the normal \"Git aware\" transport\n \tmechanism and clones the repository by making a copy of\n@@ -63,8 +63,8 @@ Git transport instead.\n \tdirectory instead of using hardlinks. This may be desirable\n \tif you are trying to make a back-up of your repository.\n \n---shared::\n -s::\n+--shared::\n \tWhen the repository to clone is on the local machine,\n \tinstead of using hard links, automatically setup\n \t`.git/objects/info/alternates` to share the objects\n@@ -116,13 +116,13 @@ objects from the source repository into a pack in the cloned repository.\n \tsame repository, and this option can be used to stop the\n \tborrowing.\n \n---quiet::\n -q::\n+--quiet::\n \tOperate quietly.  Progress is not reported to the standard\n \terror stream.\n \n---verbose::\n -v::\n+--verbose::\n \tRun verbosely. Does not affect the reporting of progress status\n \tto the standard error stream.\n \n@@ -140,8 +140,8 @@ objects from the source repository into a pack in the cloned repository.\n \tWhen multiple `--server-option=<option>` are given, they are all\n \tsent to the other side in the order listed on the command line.\n \n---no-checkout::\n -n::\n+--no-checkout::\n \tNo checkout of HEAD is performed after the clone is complete.\n \n --bare::\n@@ -164,13 +164,13 @@ objects from the source repository into a pack in the cloned repository.\n \tthat all these refs are overwritten by a `git remote update` in the\n \ttarget repository.\n \n---origin <name>::\n -o <name>::\n+--origin <name>::\n \tInstead of using the remote name `origin` to keep track\n \tof the upstream repository, use `<name>`.\n \n---branch <name>::\n -b <name>::\n+--branch <name>::\n \tInstead of pointing the newly created HEAD to the branch pointed\n \tto by the cloned repository's HEAD, point to `<name>` branch\n \tinstead. In a non-bare repository, this is the branch that will\n@@ -178,8 +178,8 @@ objects from the source repository into a pack in the cloned repository.\n \t`--branch` can also take tags and detaches the HEAD at that commit\n \tin the resulting repository.\n \n---upload-pack <upload-pack>::\n -u <upload-pack>::\n+--upload-pack <upload-pack>::\n \tWhen given, and the repository to clone from is accessed\n \tvia ssh, this specifies a non-default path for the command\n \trun on the other end.\n@@ -188,8 +188,8 @@ objects from the source repository into a pack in the cloned repository.\n \tSpecify the directory from which templates will be used;\n \t(See the \"TEMPLATE DIRECTORY\" section of linkgit:git-init[1].)\n \n---config <key>=<value>::\n -c <key>=<value>::\n+--config <key>=<value>::\n \tSet a configuration variable in the newly-created repository;\n \tthis takes effect immediately after the repository is\n \tinitialized, but before the remote history is fetched or any\n-- \ngitgitgadget\n"},{"id":"378496","messageId":"pull.277.v2.git.gitgitgadget@gmail.com","threadId":"51397","inReplyTo":"pull.277.git.gitgitgadget@gmail.com","subject":"[PATCH v2 0/2] Update git-clone doc: refer to long form of the options and list short form of the options first","fromName":"Quentin Nerden via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-07-02T14:37:39Z","receivedAt":"2019-07-02T14:37:45Z","isPatch":true,"sender":{"key":"name:Quentin Nerden","avatar":null},"body":"To make doc of git-clone easier to read, refer to the long version of the\noptions (it is easier to guess what --verbose is doing than -v).\n\nAlso: put the short options first, to match the doc of git-add, git-commit,\ngit-clean, git-branch...\n\nQuentin Nerden (2):\n  docs: git-clone: refer to long form of options\n  docs: git-clone: list short form of options first\n\n Documentation/git-clone.txt | 34 +++++++++++++++++-----------------\n 1 file changed, 17 insertions(+), 17 deletions(-)\n\n\nbase-commit: 8dca754b1e874719a732bc9ab7b0e14b21b1bc10\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-277%2Fkenden%2Fpatch-1-v2\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-277/kenden/patch-1-v2\nPull-Request: https://github.com/gitgitgadget/git/pull/277\n\nRange-diff vs v1:\n\n -:  ---------- > 1:  d2f5540ea1 docs: git-clone: refer to long form of options\n 1:  0dd1b01769 ! 2:  c562cf681f docs: update git-clone doc: refer to long options\n     @@ -1,13 +1,10 @@\n     -Author: Quentin Nerden <quentin.nerden@gmail.com>\n     +Author: Quentin Nerden <quentin.nerden@intel.com>\n      \n     -    docs: update git-clone doc: refer to long options\n     +    docs: git-clone: list short form of options first\n      \n     -    To make the doc of git-clone easier to read,\n     -    refer to the long version of the options\n     -    (it is easier to guess what --verbose is doing than -v).\n     -\n     -    Also:\n     -    put the short options first, to match the doc of git-add, git-commit, git-clean, git-branch...\n     +    List the short form of options (e.g.: '-l') before the long form (e.g.\n     +    '--local').\n     +    This is to match the doc of git-add, git-commit, git-clean, git-branch...\n      \n          Signed-off-by: Quentin Nerden <quentin.nerden@gmail.com>\n      \n     @@ -34,19 +31,6 @@\n       \tWhen the repository to clone is on the local machine,\n       \tinstead of using hard links, automatically setup\n       \t`.git/objects/info/alternates` to share the objects\n     -@@\n     - If these objects are removed and were referenced by the cloned repository,\n     - then the cloned repository will become corrupt.\n     - +\n     --Note that running `git repack` without the `-l` option in a repository\n     -+Note that running `git repack` without the `--local` option in a repository\n     - cloned with `-s` will copy objects from the source repository into a pack\n     - in the cloned repository, removing the disk space savings of `clone -s`.\n     --It is safe, however, to run `git gc`, which uses the `-l` option by\n     -+It is safe, however, to run `git gc`, which uses the `--local` option by\n     - default.\n     - +\n     - If you want to break the dependency of a repository cloned with `-s` on\n      @@\n       \tsame repository, and this option can be used to stop the\n       \tborrowing.\n     @@ -63,13 +47,6 @@\n       \tRun verbosely. Does not affect the reporting of progress status\n       \tto the standard error stream.\n       \n     - --progress::\n     - \tProgress status is reported on the standard error stream\n     --\tby default when it is attached to a terminal, unless -q\n     -+\tby default when it is attached to a terminal, unless `--quiet`\n     - \tis specified. This flag forces progress status even if the\n     - \tstandard error stream is not directed to a terminal.\n     - \n      @@\n       \tWhen multiple `--server-option=<option>` are given, they are all\n       \tsent to the other side in the order listed on the command line.\n     @@ -80,14 +57,6 @@\n       \tNo checkout of HEAD is performed after the clone is complete.\n       \n       --bare::\n     - \tMake a 'bare' Git repository.  That is, instead of\n     - \tcreating `<directory>` and placing the administrative\n     - \tfiles in `<directory>/.git`, make the `<directory>`\n     --\titself the `$GIT_DIR`. This obviously implies the `-n`\n     -+\titself the `$GIT_DIR`. This obviously implies `--no-checkout`\n     - \tbecause there is nowhere to check out the working tree.\n     - \tAlso the branch heads at the remote are copied directly\n     - \tto corresponding local branch heads, without mapping\n      @@\n       \tthat all these refs are overwritten by a `git remote update` in the\n       \ttarget repository.\n     @@ -124,13 +93,3 @@\n       \tSet a configuration variable in the newly-created repository;\n       \tthis takes effect immediately after the repository is\n       \tinitialized, but before the remote history is fetched or any\n     -@@\n     - \tThe result is Git repository can be separated from working\n     - \ttree.\n     - \n     ---j <n>::\n     - --jobs <n>::\n     -+-j <n>::\n     - \tThe number of submodules fetched at the same time.\n     - \tDefaults to the `submodule.fetchJobs` option.\n     - \n\n-- \ngitgitgadget\n"},{"id":"378514","messageId":"xmqqwoh02qrb.fsf@gitster-ct.c.googlers.com","threadId":"51397","inReplyTo":"c562cf681f5c1c47cd77eead30ec9ae1eb7ca9e0.1562078259.git.gitgitgadget@gmail.com","subject":"Re: [PATCH v2 2/2] docs: git-clone: list short form of options first","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-07-02T19:14:16Z","receivedAt":"2019-07-02T19:14:25Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Quentin Nerden via GitGitGadget\" <gitgitgadget@gmail.com> writes:\n\n> From: Quentin Nerden <quentin.nerden@intel.com>\n>\n> List the short form of options (e.g.: '-l') before the long form (e.g.\n> '--local').\n> This is to match the doc of git-add, git-commit, git-clean, git-branch...\n>\n> Signed-off-by: Quentin Nerden <quentin.nerden@gmail.com>\n> ---\n>  Documentation/git-clone.txt | 18 +++++++++---------\n>  1 file changed, 9 insertions(+), 9 deletions(-)\n\nMuch easier to follow ;-)  Thanks.\n"}]}