summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Moore <paul@paul-moore.com>2017-02-24 15:28:18 -0500
committerPaul Moore <paul@paul-moore.com>2017-02-24 15:28:18 -0500
commit9ea80e314b7b1b16e5dcf4a1d7496fd706303c90 (patch)
tree9aebc3b74cdaef7fd95e079d7b3be422d63246f8
parent3b2d6b6e3faa0a44784617554f8021627257b9da (diff)
downloadlibseccomp-9ea80e314b7b1b16e5dcf4a1d7496fd706303c90.tar.gz
doc: convert SUBMITTING_PATCHES to Markdown
Signed-off-by: Paul Moore <paul@paul-moore.com>
-rw-r--r--Makefile.am2
-rw-r--r--SUBMITTING_PATCHES.md (renamed from SUBMITTING_PATCHES)13
2 files changed, 7 insertions, 8 deletions
diff --git a/Makefile.am b/Makefile.am
index 91ba36e..29ee2ec 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -22,7 +22,7 @@ SUBDIRS = include src tools tests doc
pkgconfdir = ${libdir}/pkgconfig
pkgconf_DATA = libseccomp.pc
-EXTRA_DIST = CHANGELOG CREDITS LICENSE README.md SUBMITTING_PATCHES
+EXTRA_DIST = CHANGELOG CREDITS LICENSE README.md SUBMITTING_PATCHES.md
# support silent builds
AM_MAKEFLAGS_0 = --quiet --no-print-directory
diff --git a/SUBMITTING_PATCHES b/SUBMITTING_PATCHES.md
index 698ced8..61170ea 100644
--- a/SUBMITTING_PATCHES
+++ b/SUBMITTING_PATCHES.md
@@ -8,7 +8,7 @@ to the rules described here, but by following the instructions below you
should have a much easier time getting your work merged with the upstream
project.
-* Test Your Code
+## Test Your Code
There are three possible tests you can run to verify your code. The first
test is used to check the formatting and coding style of your changes, you
@@ -34,12 +34,11 @@ supports seccomp filters you can run the live tests with the following
command:
# make check-build
- # cd tests
- # ./regression -T live
+ # (cd tests; ./regression -T live)
... if there are any faults or errors they will be displayed.
-* Generate the Patch(es)
+## Generate the Patch(es)
Depending on how you decided to work with the libseccomp code base and what
tools you are using there are different ways to generate your patch(es).
@@ -62,7 +61,7 @@ When in doubt please generate your patch and try applying it to an unmodified
copy of the libseccomp sources; if it fails for you, it will fail for the rest
of us.
-* Explain Your Work
+## Explain Your Work
At the top of every patch you should include a description of the problem you
are trying to solve, how you solved it, and why you chose the solution you
@@ -71,7 +70,7 @@ if you can describe/include a reproducer for the problem in the description as
well as instructions on how to test for the bug and verify that it has been
fixed.
-* Sign Your Work
+## Sign Your Work
The sign-off is a simple line at the end of the patch description, which
certifies that you wrote it or otherwise have the right to pass it on as an
@@ -109,7 +108,7 @@ your real name, saying:
Signed-off-by: Random J Developer <random@developer.example.org>
-* Email Your Patch(es)
+## Email Your Patch(es)
Finally, you will need to email your patches to the mailing list so they can
be reviewed and potentially merged into the main libseccomp repository. When