threads / patch / 12047

patchgit clone -s documentation: force a new paragraph for the NOTE

Subject: [PATCH] git clone -s documentation: force a new paragraph for the NOTE

## tl;dr

3 messages between Feb 12, 2008 and Feb 12, 2008. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Miklos Vajna· Feb 12, 2008, 00:12 UTC · lore
It should be loud and clear.
Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---

I wanted this syntax when I added the NOTE but I tought it's not possible. After Junio's patch to git pull --rebase, here is a similar fix for git clone -s.

 Documentation/git-clone.txt |   13 +++++++------
 1 files changed, 7 insertions(+), 6 deletions(-)
Show changes to Documentation/git-clone.txt +7 −6
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 2341881..9758243 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.
 
 
 
-- 
1.5.4.1
Junio C Hamano· Feb 12, 2008, 03:07 UTC · re: Miklos Vajna · lore

Re: [PATCH] git clone -s documentation: force a new paragraph for the NOTE

Miklos Vajna <vmiklos@frugalware.org> writes:
Show 16 quoted lines
> It should be loud and clear.
> ...
> diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
> index 2341881..9758243 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.

The "Note" is already in bold and quite loud. I am not sure if this is worth it.

Miklos Vajna· Feb 12, 2008, 09:33 UTC · re: Junio C Hamano · lore

Re: [PATCH] git clone -s documentation: force a new paragraph for the NOTE

On Mon, Feb 11, 2008 at 07:07:39PM -0800, Junio C Hamano <gitster@pobox.com> wrote:
> The "Note" is already in bold and quite loud.  I am not sure if
> this is worth it.

okay, i may do too much nitpicking, but i think a consistent handling of NOTEs in manpages would be nice. or this doesn't matter? :S

thanks,
- VMiklos

← back to recent threads