[PATCH] README.devel: more help for git newbies

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



As a git newbie I found README.devel not to help me sufficiently.
The changes in this commit are what I would have needed earlier
i.e. almost holding hand what to do and how.

I am not quite sure about all I wrote, like the --cc
kzak@xxxxxxxxxx, or set up your own repository and send pull
request. Please review with thought before merging.

Signed-off-by: Sami Kerola <kerolasa@xxxxxx>
---
 README.devel |   68 ++++++++++++++++++++++++++++++++++++++++++++++++++++------
 1 files changed, 61 insertions(+), 7 deletions(-)

diff --git a/README.devel b/README.devel
index fdfa264..381bf75 100644
--- a/README.devel
+++ b/README.devel
@@ -16,28 +16,83 @@ AUTOTOOLS:
 
 PATCHES:
 
+     * First get familiar with git.  In case you are completely
+       lost watch Greg Kroah-Hartman explaining the very basics.
+       http://archive.fosdem.org/2010/schedule/events/linuxkernelpatch
+
      * send your patches to the mailing list or to the upstream maintainer
        (see the AUTHORS and README files)
 
-     * diff -u
-
      * don't include generated (autotools) stuff to your patches
        (hint: use git-clean [-X])
 
+     * add a Signed-off-by line, use "git commit -s"
+
      * patches are delivered via email only.  Downloading them from internet
-       servers is a pain.
+       servers is a pain.  The following commands will do the correct thing.
+
+       $ git format-patch -C origin/master..yourbranch -o ~/patches
+
+       When you send only one patch use the following.
+
+       $ git send-email --to util-linux-ng@xxxxxxxxxxxxxxx \
+                        --cc kzak@xxxxxxxxxx ~/patches/0001*
+
+       The command above expects you have configured email sending properly.
+       See git.wiki for help.
+       https://git.wiki.kernel.org/index.php/GitTips#Mail
 
      * one patch per email, with the changelog in the body of the email.
 
-     * Subject: [PATCH] subsystem: description
+     * When you send series of pathes include introductory message.
+
+       $ git send-email --compose --to util-linux-ng@xxxxxxxxxxxxxxx \
+                        --cc kzak@xxxxxxxxxx ~/patches/000*
+
+       Good introductory message will have at least
+
+       -- snip
+       Your Name (3):
+         firstfile.c: short description
+         secondfile.c: another description
+
+        firstfile.c                         |    2 +-
+        secondfile.c                        |    2 +-
+        secondfile.c                        |    2 +-
+        2 files changed, 3 insertions(+), 3 deletions(-)
+       -- snip
+
+       Above introductory can be generated with git.
+
+       $ git shortlog master..yourbranch
+       $ git diff --stat master..yourbranch
+
+     * Subject: [PATCH] subsystem: description.  Following ~/.gitconfig will
+       help you a little.
+
+       -- snip
+       [user]
+               name = Your Name
+               email = your.name@xxxxxxxxxxx
+
+       [format]
+               subjectprefix = PATCH
+               numbered = auto
+               signoff = yes
+
+       [sendemail]
+               chainreplyto = false
+               cc = your.name@xxxxxxxxxxx
+       -- snip
+
+     * for more than 9 patches set up your own git repository, reachable
+       from internet, and send pull request
 
      * if someone else wrote the patch, they should be credited (and blamed)
        for it. To communicate this, add a line:
 
           From: John Doe <jdoe@xxxxxxxxxxxx>
 
-     * add a Signed-off-by line (hint: use "git commit -s")
-
        The sign-off is a simple line at the end of the explanation for the
        patch, which certifies that you wrote it or otherwise have the right to
        pass it on as a open-source patch.  The rules are pretty simple: if you
@@ -90,7 +145,6 @@ SCM (source code management):
 
      git clone git://git.kernel.org/pub/scm/utils/util-linux-ng/util-linux-ng.git util-linux-ng
 
-
     * maintenance (stable) branch
         - created for every <major>.<minor> release
         - branch name: stable/v<major>.<minor>
-- 
1.7.3.1

--
To unsubscribe from this list: send the line "unsubscribe util-linux-ng" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Netdev]     [Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux