From 451e593181c554b06f1ce292b4233d396a355753 Mon Sep 17 00:00:00 2001 From: Mike Ralphson Date: Fri, 7 Sep 2007 17:43:37 +0100 Subject: Documentation / grammer nit If we're counting, a smaller number is 'fewer' not 'less' Signed-off-by: Mike Ralphson Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 227f092e26..253f4f03c5 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -68,7 +68,7 @@ OPTIONS automatically setup .git/objects/info/alternates to obtain objects from the reference repository. Using an already existing repository as an alternate will - require less objects to be copied from the repository + require fewer objects to be copied from the repository being cloned, reducing network and local storage costs. --quiet:: -- cgit v1.2.3 From d9d10bb8549ca0353d13298e372c1c87bcc530ef Mon Sep 17 00:00:00 2001 From: Ralf Wildenhues Date: Thu, 1 Nov 2007 09:46:02 +0100 Subject: git-clone.txt: Improve --depth description. Avoid abbreviation 'revs', improve the language a bit. Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 253f4f03c5..cca14d6b5d 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -111,11 +111,11 @@ OPTIONS --depth :: Create a 'shallow' clone with a history truncated to the - specified number of revs. A shallow repository has + specified number of revisions. A shallow repository has a number of limitations (you cannot clone or fetch from it, nor push from nor into it), but is adequate if you - want to only look at near the tip of a large project - with a long history, and would want to send in a fixes + are only interested in the recent history of a large project + with a long history, and would want to send in fixes as patches. :: -- cgit v1.2.3 From 19391c371cec06da6cca45dbe3c212bd479cc48c Mon Sep 17 00:00:00 2001 From: Heikki Orsila Date: Thu, 1 Nov 2007 16:21:39 +0200 Subject: git-clone: honor "--" to end argument parsing Signed-off-by: Heikki Orsila --- Documentation/git-clone.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index cca14d6b5d..14e58f3866 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -12,7 +12,7 @@ SYNOPSIS 'git-clone' [--template=] [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [-o ] [-u ] [--reference ] - [--depth ] [] + [--depth ] [--] [] DESCRIPTION ----------- -- cgit v1.2.3 From 347989f4ea9f7ced91c482e4d77cc50ed31d2f50 Mon Sep 17 00:00:00 2001 From: Sergei Organov Date: Fri, 16 Nov 2007 21:43:16 +0300 Subject: Documentation: fix git-clone manpage not to refer to itself Signed-off-by: Sergei Organov Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 1 + 1 file changed, 1 insertion(+) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 14e58f3866..c90bcece24 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -130,6 +130,7 @@ OPTIONS for "host.xz:foo/.git"). Cloning into an existing directory is not allowed. +:git-clone: 1 include::urls.txt[] Examples -- cgit v1.2.3 From 5162e69732d13dd079919a389a6ace8878aad716 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Sat, 29 Dec 2007 00:20:38 -0600 Subject: Documentation: rename gitlink macro to linkgit Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock Asciidoc configuration: @@ -149,7 +153,10 @@ # Inline macros. # Backslash prefix required for escape processing. # (?s) re flag for line spanning. -(?su)[\\]?(?P\w(\w|-)*?):(?P\S*?)(\[(?P.*?)\])= + +# Explicit so they can be nested. +(?su)[\\]?(?P(http|https|ftp|file|mailto|callto|image|link)):(?P\S*?)(\[(?P.*?)\])= + # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P[\w][\w-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] This default regex now matches explicit values, and unfortunately in this case gitlink was being matched by just 'link', causing the wrong inline macro template to be applied. By renaming the macro, we can avoid being matched by the wrong regex. Signed-off-by: Dan McGee Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index c90bcece24..fdccbd4cbe 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -191,4 +191,4 @@ Documentation by Junio C Hamano and the git-list . GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite -- cgit v1.2.3 From 28678b4f2f2e449986de4a6fc2dc93b32299ca74 Mon Sep 17 00:00:00 2001 From: Miklos Vajna Date: Tue, 22 Jan 2008 23:12:25 +0100 Subject: git-clone -s: document problems with git gc --prune There is a scenario when using git clone -s and git gc --prune togother is dangerous. Document this. Signed-off-by: Miklos Vajna Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index fdccbd4cbe..2341881614 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -62,6 +62,14 @@ OPTIONS .git/objects/info/alternates to share the objects with the source repository. The resulting repository starts out without any object of its own. + *NOTE*: this is a possibly dangerous operation; do *not* use + it unless you understand what it does. If you clone your + repository using this option, then delete branches in the + source repository and then run linkgit:git-gc[1] using the + '--prune' option in the source repository, it may remove + objects which are referenced by the cloned repository. + + --reference :: If the reference repository is on the local machine -- cgit v1.2.3 From 846688726c388cf7fc92ac5cc9f3576e93847e15 Mon Sep 17 00:00:00 2001 From: Miklos Vajna Date: Tue, 12 Feb 2008 01:12:57 +0100 Subject: git clone -s documentation: force a new paragraph for the NOTE It should be loud and clear. Signed-off-by: Miklos Vajna Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 2341881614..975824301a 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -62,12 +62,13 @@ OPTIONS .git/objects/info/alternates to share the objects with the source repository. The resulting repository starts out without any object of its own. - *NOTE*: this is a possibly dangerous operation; do *not* use - it unless you understand what it does. If you clone your - repository using this option, then delete branches in the - source repository and then run linkgit:git-gc[1] using the - '--prune' option in the source repository, it may remove - objects which are referenced by the cloned repository. ++ +*NOTE*: this is a possibly dangerous operation; do *not* use +it unless you understand what it does. If you clone your +repository using this option, then delete branches in the +source repository and then run linkgit:git-gc[1] using the +'--prune' option in the source repository, it may remove +objects which are referenced by the cloned repository. -- cgit v1.2.3 From 2498a1ad0b0fc06f1fd40074b9bb55eb3d7ae094 Mon Sep 17 00:00:00 2001 From: Brandon Casey Date: Thu, 3 Apr 2008 13:26:13 -0500 Subject: git-clone.txt: Adjust note to --shared for new pruning behavior of git-gc Since git-gc now always calls prune, even with --auto, unreferenced objects may be removed by more operations than just git-gc. This is important for clones created using --shared or --reference. Signed-off-by: Brandon Casey Signed-off-by: Dmitry Potapov Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 975824301a..9b564420c5 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -65,10 +65,13 @@ OPTIONS + *NOTE*: this is a possibly dangerous operation; do *not* use it unless you understand what it does. If you clone your -repository using this option, then delete branches in the -source repository and then run linkgit:git-gc[1] using the -'--prune' option in the source repository, it may remove -objects which are referenced by the cloned repository. +repository using this option and then delete branches (or use any +other git command that makes any existing commit unreferenced) in the +source repository, some objects may become unreferenced (or dangling). +These objects may be removed by normal git operations (such as git-commit[1]) +which automatically call git-gc[1]. If these objects are removed and +were referenced by the cloned repository, then the cloned repository +will become corrupt. @@ -79,6 +82,8 @@ objects which are referenced by the cloned repository. 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. ++ +*NOTE*: see NOTE to --shared option. --quiet:: -q:: -- cgit v1.2.3 From 9e1f0a85c68323830ea117092c55192b17aa3ac8 Mon Sep 17 00:00:00 2001 From: Christian Couder Date: Fri, 6 Jun 2008 09:07:32 +0200 Subject: documentation: move git(7) to git(1) As the "git" man page describes the "git" command at the end-user level, it seems better to move it to man section 1. Signed-off-by: Christian Couder Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 9b564420c5..7973e6af4c 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -205,4 +205,4 @@ Documentation by Junio C Hamano and the git-list . GIT --- -Part of the linkgit:git[7] suite +Part of the linkgit:git[1] suite -- cgit v1.2.3 From b1889c36d85514e5e70462294c561a02c2edfe2b Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Mon, 30 Jun 2008 01:09:04 -0500 Subject: Documentation: be consistent about "git-" versus "git " Since the git-* commands are not installed in $(bindir), using "git-command " in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.) This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form. The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical. Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 7973e6af4c..852b4785da 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -9,7 +9,7 @@ git-clone - Clone a repository into a new directory SYNOPSIS -------- [verse] -'git-clone' [--template=] +'git clone' [--template=] [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [-o ] [-u ] [--reference ] [--depth ] [--] [] -- cgit v1.2.3 From 483bc4f045881b998512ae814d6cf44d0c0cb493 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Mon, 30 Jun 2008 13:56:34 -0500 Subject: Documentation formatting and cleanup Following what appears to be the predominant style, format names of commands and commandlines both as `teletype text`. While we're at it, add articles ("a" and "the") in some places, italicize the name of the command in the manual page synopsis line, and add a comma or two where it seems appropriate. Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 852b4785da..eef95a404a 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -68,10 +68,10 @@ it unless you understand what it does. If you clone your repository using this option and then delete branches (or use any other git command that makes any existing commit unreferenced) in the source repository, some objects may become unreferenced (or dangling). -These objects may be removed by normal git operations (such as git-commit[1]) -which automatically call git-gc[1]. If these objects are removed and -were referenced by the cloned repository, then the cloned repository -will become corrupt. +These objects may be removed by normal git operations (such as `git-commit`) +which automatically call `git gc --auto`. (See linkgit:git-gc[1].) +If these objects are removed and were referenced by the cloned repository, +then the cloned repository will become corrupt. @@ -88,7 +88,7 @@ will become corrupt. --quiet:: -q:: Operate quietly. This flag is passed to "rsync" and - "git-fetch-pack" commands when given. + `git-fetch-pack` commands when given. --no-checkout:: -n:: @@ -114,7 +114,7 @@ will become corrupt. --upload-pack :: -u :: When given, and the repository to clone from is handled - by 'git-fetch-pack', '--exec=' is passed to + by `git-fetch-pack`, `--exec=` is passed to the command to specify non-default path for the command run on the other end. -- cgit v1.2.3 From ba020ef5eb5fca3d757bd580ff117adaf81ca079 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Thu, 3 Jul 2008 00:41:41 -0500 Subject: manpages: italicize git command names (which were in teletype font) The names of git commands are not meant to be entered at the commandline; they are just names. So we render them in italics, as is usual for command names in manpages. Using doit () { perl -e 'for (<>) { s/\`(git-[^\`.]*)\`/'\''\1'\''/g; print }' } for i in git*.txt config.txt diff*.txt blame*.txt fetch*.txt i18n.txt \ merge*.txt pretty*.txt pull*.txt rev*.txt urls*.txt do doit <"$i" >"$i+" && mv "$i+" "$i" done git diff . Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index eef95a404a..91efac920e 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -68,7 +68,7 @@ it unless you understand what it does. If you clone your repository using this option and then delete branches (or use any other git command that makes any existing commit unreferenced) in the source repository, some objects may become unreferenced (or dangling). -These objects may be removed by normal git operations (such as `git-commit`) +These objects may be removed by normal git operations (such as 'git-commit') which automatically call `git gc --auto`. (See linkgit:git-gc[1].) If these objects are removed and were referenced by the cloned repository, then the cloned repository will become corrupt. @@ -88,7 +88,7 @@ then the cloned repository will become corrupt. --quiet:: -q:: Operate quietly. This flag is passed to "rsync" and - `git-fetch-pack` commands when given. + 'git-fetch-pack' commands when given. --no-checkout:: -n:: @@ -114,7 +114,7 @@ then the cloned repository will become corrupt. --upload-pack :: -u :: When given, and the repository to clone from is handled - by `git-fetch-pack`, `--exec=` is passed to + by 'git-fetch-pack', `--exec=` is passed to the command to specify non-default path for the command run on the other end. -- cgit v1.2.3 From d3296e37b61fdd80a8b785270b1d11db34dab2f5 Mon Sep 17 00:00:00 2001 From: Steve Haslam Date: Fri, 25 Jul 2008 19:37:48 +0100 Subject: Remove references to git-fetch-pack from "git clone" documentation. "git clone" no longer calls "git-fetch-pack", so the documentation is a bit stale. Instead, state that the -u option is to be used when accessing a repository over ssh. Signed-off-by: Steve Haslam Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 91efac920e..26fd1b1117 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -87,8 +87,8 @@ then the cloned repository will become corrupt. --quiet:: -q:: - Operate quietly. This flag is passed to "rsync" and - 'git-fetch-pack' commands when given. + Operate quietly. This flag is also passed to the `rsync' + command when given. --no-checkout:: -n:: @@ -113,9 +113,8 @@ then the cloned repository will become corrupt. --upload-pack :: -u :: - When given, and the repository to clone from is handled - by 'git-fetch-pack', `--exec=` is passed to - the command to specify non-default path for the command + When given, and the repository to clone from is accessed + via ssh, this specifies a non-default path for the command run on the other end. --template=:: -- cgit v1.2.3 From bc699afcce3c45bb17aaca145d081992ed699a42 Mon Sep 17 00:00:00 2001 From: Johannes Schindelin Date: Sat, 2 Aug 2008 21:38:56 +0200 Subject: clone: Add an option to set up a mirror The command line $ git clone --mirror $URL is now a short-hand for $ git clone --bare $URL $ (cd $(basename $URL) && git remote add --mirror origin $URL) Signed-off-by: Johannes Schindelin Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 26fd1b1117..0e14e732fd 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'git clone' [--template=] - [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] + [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror] [-o ] [-u ] [--reference ] [--depth ] [--] [] @@ -106,6 +106,9 @@ then the cloned repository will become corrupt. used, neither remote-tracking branches nor the related configuration variables are created. +--mirror:: + Set up a mirror of the remote repository. This implies --bare. + --origin :: -o :: Instead of using the remote name 'origin' to keep track -- cgit v1.2.3 From 21188b1eafd3741fda0f7905dc997279a17b50ba Mon Sep 17 00:00:00 2001 From: Miklos Vajna Date: Thu, 9 Oct 2008 01:40:32 +0200 Subject: Implement git clone -v The new -v option forces the progressbar, even in case the output is not a terminal. This can be useful if the caller is an IDE or wrapper which wants to scrape the progressbar from stderr and show its information in a different format. Signed-off-by: Miklos Vajna Signed-off-by: Shawn O. Pearce --- Documentation/git-clone.txt | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 0e14e732fd..95f08b9114 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -90,6 +90,11 @@ then the cloned repository will become corrupt. Operate quietly. This flag is also passed to the `rsync' command when given. +--verbose:: +-v:: + Display the progressbar, even in case the standard output is not + a terminal. + --no-checkout:: -n:: No checkout of HEAD is performed after the clone is complete. -- cgit v1.2.3 From 5bd27ebb18f2dd745d1226b59b9f863c63c15fb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Holger=20Wei=C3=9F?= Date: Tue, 31 Mar 2009 18:57:01 +0200 Subject: Documentation: Remove an odd "instead" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Holger Weiß Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 0e14e732fd..307f2521b4 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -112,7 +112,7 @@ then the cloned repository will become corrupt. --origin :: -o :: Instead of using the remote name 'origin' to keep track - of the upstream repository, use instead. + of the upstream repository, use . --upload-pack :: -u :: -- cgit v1.2.3 From ec00d6e0038e030cf73182374e21025c2776cb23 Mon Sep 17 00:00:00 2001 From: Alexander Potashev Date: Thu, 7 May 2009 16:04:08 +0400 Subject: Documentation: cloning to empty directory is allowed Cloning into an existing empty directory is now allowed: commit 55892d23981917aefdb387ad7d0429f90cbd446a ("Allow cloning to an existing empty directory") Signed-off-by: Alexander Potashev Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-clone.txt') diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 4072f40d7a..b14de6c407 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -149,7 +149,7 @@ then the cloned repository will become corrupt. 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 not allowed. + is only allowed if the directory is empty. :git-clone: 1 include::urls.txt[] -- cgit v1.2.3