git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Adeodato Simó" <dato@net.com.org.es>
To: git@vger.kernel.org, gitster@pobox.com
Cc: "Mikael Magnusson" <mikachu@gmail.com>,
	"Joey Hess" <joey@kitenet.net>,
	"Adeodato Simó" <dato@net.com.org.es>
Subject: [PATCH] git-clone.txt: document that pushing from a shallow clone may work
Date: Tue,  3 Mar 2009 12:33:37 +0100	[thread overview]
Message-ID: <1236080017-13987-1-git-send-email-dato@net.com.org.es> (raw)
In-Reply-To: <237967ef0902160200r2320687ai71e62047c3ead9ad@mail.gmail.com>

The documentation used to say that pushing from a shallow clone is not
supported; this is true, though it may work in some simple cases. If a
user notices this fact, such a mismatch between documentation and reality
may leave them assuming the documentation is wrong and that pushing from
a shallow clone is supported.

This commit updates the documentation to say that pushing from a shallow
clone may work in some cases, but that it's not guaranteed to always do.

Signed-off-by: Adeodato Simó <dato@net.com.org.es>
---
Hello,

this is about http://thread.gmane.org/gmane.comp.version-control.git/110100,
which got a single reply from Mikael Magnusson stating:

> AFAIK, it will work in simple cases, but isn't guaranteed to work.

If that's the case, I think it should be documented, for the reasons
explained in the commit message.

Thanks!

 Documentation/git-clone.txt |    6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 95f08b9..1b4f864 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -133,8 +133,10 @@ then the cloned repository will become corrupt.
 --depth <depth>::
 	Create a 'shallow' clone with a history truncated to the
 	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
+	number of limitations: you cannot clone or fetch from it,
+	nor push into it; pushing from it into a regular repository
+	may work correctly in some cases, but it is not guaranteed to
+	always work.  However, a shallow repository is adequate if you
 	are only interested in the recent history of a large project
 	with a long history, and would want to send in fixes
 	as patches.
-- 
1.6.2.rc2.271.ge939

  reply	other threads:[~2009-03-03 11:35 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-02-12 22:02 pushing from a shallow repo allowed? Joey Hess
2009-02-16 10:00 ` Mikael Magnusson
2009-03-03 11:33   ` Adeodato Simó [this message]
2009-03-03 11:57     ` [PATCH] git-clone.txt: document that pushing from a shallow clone may work Johannes Sixt
2009-03-03 12:08       ` Adeodato Simó
2009-03-03 19:27         ` Jay Soffian
2009-03-04 10:19           ` Adeodato Simó
2009-03-04 10:45             ` Junio C Hamano
2009-03-04 11:11               ` Johannes Schindelin
2009-03-05  0:41                 ` Junio C Hamano
2009-03-04 22:22               ` Adeodato Simó

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1236080017-13987-1-git-send-email-dato@net.com.org.es \
    --to=dato@net.com.org.es \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=joey@kitenet.net \
    --cc=mikachu@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).