使用git send-mail提交Linux内核补丁

本文是在Ubunt 12.04环境下测试的。

1、安装必要的软件

1. # apt-get install git git-core git-email

2、配置send-email的环境，主要是设置本地email的客户端，用msmtp

vim ~/.msmtprc
 

1. # default
   
2. account gmail
   
3. protocol smtp
   
4. host smtp.gmail.com
   
5. from [e-mail]
   
6. user [e-mail]
   
7. password ******
   
8. port 587 
   
9. auth on
   
10. tls on
    
11. tls_trust_file /etc/ssl/certs/ca-certificates.crt
    
12. syslog LOG_MAIL
    
13. 
    
14. # set a default account
    
15. account default : gmail

3、设置git send-email的配置
vim ~/.gitconfig

1. [user]
   
2.     name = your name
   
3.     email = [e-mail]
   
4. 
   
5. [sendemail]
   
6.         smtpencryption = tls 
   
7.         smtpuser = [e-mail]
   
8.         smtpserverport = 587 
   
9.         smtpserver = smtp.gmail.com 
   
10. # to = [e-mail]
    
11. # cc = [e-mail]
    
12. # from = [e-mail]

        

其中，上面配置文件的最后三行在git send-email发送补丁文件时也可以通过命令行指定。建议大家最好通过命令行指定，因为内核补丁文件需要发送给相关模块的maintainer。

4、下面就以实例来说明如果制作一个符合规范的内核补丁。
Linux内核补丁的制作规范和发送格式参见内核文档Documentation/SubmittingPatches。
a、修改内核

1. diff --git a/net/sunrpc/auth_null.c b/net/sunrpc/auth_null.c
   
2. index a5c36c0..f8e0d73 100644
   
3. --- a/net/sunrpc/auth_null.c
   
4. +++ b/net/sunrpc/auth_null.c
   
5. @@ -27,6 +27,7 @@ nul_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
   
6.  static void
   
7.  nul_destroy(struct rpc_auth *auth)
   
8.  {
   
9. + pr_info("hellor world!\n");
   
10.  }

b、提交修改

1. git commit -a -s -m"test" -e

其中，-a表示all，-s表示在补丁文件头部增加Signed-off-by行，-m表示指定commit信息，-e表示使用git默认的编辑器来对commit信息进一步编辑，我这里默认的编辑器是nano。关于更详细的参数选项可以用命令git commit -h来察看。

执行上面那个命令以后，会进入到nano编辑器中，然后进行编辑。其中第一行显示的是补丁文件头部的Subject信息，第二行文字显示的是补丁文件的注释信息。编辑完以后，ctrl-o保存，ctrl-x退出。  
 
 
c、生成补丁文件

1. git format-patch -1

其中，-1表示生成一个补丁文件，即最后git commit时的修改。用vim打开补丁文件，如下所示：

 
 
之所以要有Subject，Signed-off-by文件，那是因为内核文档Documentation/SubmittingPatches文件中有说明：

15) The canonical patch format

The canonical patch subject line is: 

    Subject: [PATCH 001/123] subsystem: summary phrase

The canonical patch message body contains the following:

- A "from" line specifying the patch author.

- An empty line.

- The body of the explanation, which will be copied to the 
    permanent changelog to describe this patch.

- The "Signed-off-by:" lines, described above, which will
    also go in the changelog.

- A marker line containing simply "---".

- Any additional comments not suitable for the changelog.

- The actual patch (diff output).

d、检测补丁
制作完补丁文件以后，不要急着把补丁文件mail出去，需要先检测一下这个补丁的正确性。内核中提供了一个补丁检测脚本。在内核源代码根目录下，补丁检测如下：

1. # ./scripts/checkpatch.pl 0001-nfs-add-a-pr_info.patch 
   
2. total: 0 errors, 0 warnings, 7 lines checked
   
3. 
   
4. 0001-nfs-add-a-pr_info.patch has no obvious style problems and is ready for submission.

e、确定补丁发送给谁
补丁检测通过以后，就可以mail出去了。但是该mail给谁呢？嗯，内核里面也同样提供了一个脚本，用于检测某个目录的maintainer是谁。以我修改的net/sunrpc目录里面的文件为例，执行下面的命令：

1. root@bandari-PC:~/code/linux-3.5.4# ./scripts/get_maintainer.pl net/sunrpc/ -f
   
2. Trond Myklebust <[e-mail]> (maintainer:NFS, SUNRPC, AND...)
   
3. "J. Bruce Fields" <[e-mail]> (supporter:KERNEL NFSD, SUNR...)
   
4. "David S. Miller" <[e-mail]> (maintainer:NETWORKING [GENERAL])
   
5. [e-mail] (open list:NFS, SUNRPC, AND...)
   
6. [e-mail] (open list:NETWORKING [GENERAL])
   
7. [e-mail] (open list)

从上面输出可以看到，email destination有三个人。而后面的3个则用于email carbon copy (cc)，即抄送。

5、发送补丁
命令如下所示：

1. root@bandari-PC:~# git send-email --smtp-server /usr/bin/msmtp --to [e-mail] 
   
2. --cc [e-mail] 0001-nfs-add-a-pr_info.patch

其中，git send-email的选项选项说明如下：
--to 邮件的To地址 sendmail.to
--cc 邮件的Cc地址 sendmail.cc
--smtp-server SMTP服务器名称 sendmail.smtp-server

关于git send-email的详细选项说明，可以通过执行命令git send-email -h察看。
注意，这里是通过命令行参数设置，前面说过，在~/.msmtprc文件也可以设置全局参数。
如果大家要测试的话，可以将--to和--cc设置成自己的邮箱地址。