From: Mauro Carvalho Chehab <m.chehab@samsung.com>
Date: Wed, 12 Feb 2014 23:13:18 +0000 (+0900)
Subject: Update README to reflect the patch submission process
X-Git-Tag: v0.5.0~4
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=19a27b6f977cdf2ecf59b18e8cd3c77a379af89b;p=users%2Fmchehab%2Frasdaemon.git

Update README to reflect the patch submission process

That helps to better document how to contribute with code.

Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
---

diff --git a/README b/README
index 9419ab2..147c092 100644
--- a/README
+++ b/README
@@ -78,7 +78,7 @@ by installing the following packages:
 	libtool
 	tar
 	sqlite-devel	(if sqlite3 will be used)
-	perl-dbd-sqlite	(if sqlite3 will be used)
+	perl-DBD-SQLite	(if sqlite3 will be used)
 
 To install then on Fedora, run:
 	yum install -y make gcc autoconf automake libtool tar perl-dbd-sqlite
@@ -90,7 +90,7 @@ There are currently 3 features that are enabled optionally, via
 ./configure parameters:
 
   --enable-sqlite3        enable storing data at SQL lite database (currently
-                          experimental)
+			  experimental)
   --enable-aer            enable PCIe AER events (currently experimental)
   --enable-mce            enable MCE events (currently experimental)
 
@@ -168,3 +168,64 @@ APEI error injection can use this tool:
 
 AER error injection can use this tool:
 	https://git.kernel.org/cgit/linux/kernel/git/gong.chen/aer-inject.git/
+
+SUBMITTING PATCHES
+==================
+
+If you want to help improving this tool, be my guest! We try to follow
+the Kernel's CodingStyle and submission rules as a reference. Please
+send patches enclosed in an email, in plain text, to:
+	Mauro Carvalho Chehab <m.chehab@samsung.com>
+		or
+	Mauro Carvalho Chehab <mchehab@infradead.org>
+
+Sending a copy also to linux-edac@vger.kernel.org.
+
+Don't foget to add a description of the patch in the body of the email, adding
+a Signed-off-by: at the end of the patch description (before the unified diff
+with the patch).
+
+We use Signed-off-by the same way as in kernel, so I'm transcribing
+bellow the same text as found under Kernel's Documentation/SubmittingPatches:
+
+	"To improve tracking of who did what, especially with patches that can
+	percolate to their final resting place in the kernel through several
+	layers of maintainers, we've introduced a "sign-off" procedure on
+	patches that are being emailed around.
+
+	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 an open-source patch.  The rules are pretty simple: if you
+	can certify the below:
+
+		Developer's Certificate of Origin 1.1
+
+		By making a contribution to this project, I certify that:
+
+		(a) The contribution was created in whole or in part by me and I
+		    have the right to submit it under the open source license
+		indicated in the file; or
+
+		(b) The contribution is based upon previous work that, to the best
+		    of my knowledge, is covered under an appropriate open source
+		    license and I have the right under that license to submit that
+		    work with modifications, whether created in whole or in part
+		    by me, under the same open source license (unless I am
+		    permitted to submit under a different license), as indicated
+		    in the file; or
+
+		(c) The contribution was provided directly to me by some other
+		    person who certified (a), (b) or (c) and I have not modified
+		    it.
+
+		(d) I understand and agree that this project and the contribution
+		    are public and that a record of the contribution (including all
+		    personal information I submit with it, including my sign-off) is
+		    maintained indefinitely and may be redistributed consistent with
+		    this project or the open source license(s) involved.
+
+	then you just add a line saying
+
+		Signed-off-by: Random J Developer <random@developer.example.org>
+
+	using your real name (sorry, no pseudonyms or anonymous contributions.)"