threads / patch / 16888

patchDocumentation/git-format-patch.txt: fix weird backslash at --root

Subject: [PATCH] Documentation/git-format-patch.txt: fix weird backslash at --root

## tl;dr

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

replies: 2people: 2as markdown or json

jidanni@jidanni.org· Dec 27, 2008, 19:57 UTC · lore

However note --root is not mentioned in SYNOPSIS nor on its own line. Also fixed grammar.

Signed-off-by: jidanni <jidanni@jidanni.org>

Show changes to git-format-patch.txt +3 −3

diff --git a/git-format-patch.txt b/git-format-patch.txt
index ee27eff..51c25cd 100644
--- a/git-format-patch.txt
+++ b/git-format-patch.txt
@@ -48 +48 @@ everything since project inception to one commit, say "git
-format-patch \--root <commit>" to make it clear that it is the
+format-patch --root <commit>" to make it clear that it is the
@@ -166 +166 @@ not add any suffix.
-	that they differ.  Note that this disable the patch to be properly
+	that they differ.  Note that this disables the patch from being properly
@@ -209 +209 @@ project:
-$ git format-patch \--root origin
+$ git format-patch --root origin

-- 
1.5.6.5

Junio C Hamano· Dec 27, 2008, 22:15 UTC · re: jidanni@jidanni.org · lore

Re: [PATCH] Documentation/git-format-patch.txt: fix weird backslash at --root

jidanni@jidanni.org writes:

> @@ -209 +209 @@ project:
> -$ git format-patch \--root origin
> +$ git format-patch --root origin

I thought these backslashes before double-dash are protecting the latter from being turned into em-dashes. I do not see any weird backslash in the "git help" (aka "manpage") output nor in the HTML documentation, e.g.

    http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html

without your patch, so I have to say that this chunk is a useless churn.

All of your three patches lack context, which is essential enabler for easier review. They have "diff --git" header, but are not made relative to the root of the project tree (i.e. lack "Documentation/" prefix), which is the norm for both the tool and for this project and this mailing list.

I guess that you may be experimenting with various options to see how they work, and the curiosity by itself is a good thing, but please do not make other people suffer with results from such experiments by sending patches in nonstandard forms.

By submitting a patch to try improving the system, you are already making a difference in substance. Please do not try to be creative in form. It only makes lives of other people unnecessarily harder with no real reason and wastes other people's time. And it wastes yours, too. A patch conforming to the norm is much easier to review, comment on and apply. Ok?

"Don't try to be different in form, make a difference in substance" also applies to your S-o-b line, by the way.

jidanni@jidanni.org· Dec 27, 2008, 22:36 UTC · re: Junio C Hamano · lore

Re: [PATCH] Documentation/git-format-patch.txt: fix weird backslash at --root

JCH> http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html
That looks OK. All I know is on Debian (1:1.5.6.5-2) it gets rendered:
$ w3m -dump /usr/share/doc/git-doc/git-format-patch.html|fgrep \\-
    $ git format-patch \--root origin

I was patching offline from Debian. OK, in the future I will clone upstream directly properly first.