From: Randy Dunlap <[email protected]>
Add git pull command info and diffstat summary info so that we don't
have to search email archives for it repeatedly.
Signed-off-by: Randy Dunlap <[email protected]>
---
Documentation/SubmittingPatches | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
--- linux-2.6.26-git8.orig/Documentation/SubmittingPatches
+++ linux-2.6.26-git8/Documentation/SubmittingPatches
@@ -528,7 +528,33 @@ See more details on the proper patch for
references.
+16) Sending "git pull" requests (from Linus emails)
+Please write the git repo address and branch name alone on the same line
+so that I can't even by mistake pull from the wrong branch, and so
+that a triple-click just selects the whole thing.
+
+So the proper format is something along the lines of:
+
+ "Please pull from
+
+ git://jdelvare.pck.nerim.net/jdelvare-2.6 i2c-for-linus
+
+ to get these changes:"
+
+so that I don't have to hunt-and-peck for the address and inevitably
+get it wrong (actually, I've only gotten it wrong a few times, and
+checking against the diffstat tells me when I get it wrong, but I'm
+just a lot more comfortable when I don't have to "look for" the right
+thing to pull, and double-check that I have the right branch-name).
+
+
+Please use "git diff -M --stat --summary" to generate the diffstat:
+the -M enables rename detection, and the summary enables a summary of
+new/deleted or renamed files.
+
+With rename detection, the statistics are rather different [...]
+because git will notice that a fair number of the changes are renames.
-----------------------------------
SECTION 2 - HINTS, TIPS, AND TRICKS
---
Randy Dunlap wrote:
> Add git pull command info and diffstat summary info so that we don't
> have to search email archives for it repeatedly.
Isn't SubmittingPatches the wrong text for this?
Patch submission is through e-mail alone, not through git pull requests.
--
Stefan Richter
-=====-==--- -=== ===--
http://arcgraph.de/sr/
On Mon, 28 Jul 2008 13:29:00 +0200 Stefan Richter wrote:
> Randy Dunlap wrote:
> > Add git pull command info and diffstat summary info so that we don't
> > have to search email archives for it repeatedly.
>
> Isn't SubmittingPatches the wrong text for this?
Is there a good place for it?
> Patch submission is through e-mail alone, not through git pull requests.
Thanks for the feedback.
---
~Randy
Linux Plumbers Conference, 17-19 September 2008, Portland, Oregon USA
http://linuxplumbersconf.org/
Randy Dunlap wrote:
> On Mon, 28 Jul 2008 13:29:00 +0200 Stefan Richter wrote:
>> Isn't SubmittingPatches the wrong text for this?
>
> Is there a good place for it?
I am alas not aware of a well fitting place.
But I see that it was already committed. Hence a sentence should be
added about whether/when/what for to publish proposed changes in a git tree.
> Thanks for the feedback.
Here is some more, after the fact:
- The two points that you are making...
(a) The repo URL should be convenient for cut'n'paste, i.e.
complete with protocol specifier like git:// and followed by the
branch name from which to pull, without line break between them.
(b) Include a shortlog and a diffstat generated by "git diff -M
--stat --summary". This properly shows file renames, creations,
deletions.
...can be told with far fewer words.
- You could mention that 'git request-pull' can be used to generate
the message text.
- Since this was placed in SubmittingPatches (targeted to submitters
rather than subsystem maintainers), it surely is noteworthy that a
pull request or announcement of a repo should sufficiently explain
the purpose of the repo or request, including its status WRT testing
and review, similar to a "[patch 0/n]" post.
PS: SubmittingPatches doesn't mention the "do"s and "don't"s of [patch
0/n] posts yet...
--
Stefan Richter
-=====-==--- -=== ===--
http://arcgraph.de/sr/