From: Alejandro Colomar Date: Wed, 6 Nov 2024 20:55:46 +0000 (+0100) Subject: CONTRIBUTING.d/patches/description: Add file documenting the description of a patch X-Git-Tag: man-pages-6.10~119 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ef7e6db57ddd5aaf3ea9d4679e025e8549d32b81;p=thirdparty%2Fman-pages.git CONTRIBUTING.d/patches/description: Add file documenting the description of a patch Signed-off-by: Alejandro Colomar --- diff --git a/CONTRIBUTING.d/patches/description b/CONTRIBUTING.d/patches/description new file mode 100644 index 000000000..c19899f46 --- /dev/null +++ b/CONTRIBUTING.d/patches/description @@ -0,0 +1,55 @@ +Name + patches/description - instructions for writing a patch description + +Description + The descrpiption of a patch is commonly known as commit message. + it should describe the patch, including any details that may be + of importance for its review. It is formed by the subject, a + blank line, the body, a blank line, and the trailer. + + Subject + See . + + Body + Describe how you obtained the information in your patch. For + example, was it: + + - by reading (or writing) the relevant kernel or (g)libc source + code? Please provide a pointer to the relevant code. + + - from a commit message in the kernel or (g)libc source code + repository? Please provide a commit ID. + + - by writing a test program? Send it with the patch, but + please make sure it's as simple as possible, and provide + instructions on how to use it and/or a demo run. + + - from a standards document? Please name the standard, and + quote the relevant text. + + - from other documentation? Please provide a pointer to that + documentation. + + - from a mailing list or online forum? Please provide a URL + if possible. + + Where relevant, cite commit hashes for relevant kernel or glibc + changes: + + linux.git f4b89d8ce5a8 ("landlock: Various documentation improvements") + + Style guide + URIs should always be enclosed in <>. + + The correct inter-sentence space amount is two. + + Trailer + Sign your patch with "Signed-off-by:". Read about the + "Developer's Certificate of Origin" at + . + When appropriate, other tags documented in that file, such as + "Reported-by:", "Reviewed-by:", "Acked-by:", and "Suggested-by:" + can be added to the patch. We use "Co-authored-by:" instead of + "Co-developed-by:". Example: + + Signed-off-by: Alejandro Colomar diff --git a/CONTRIBUTING.d/patches/patches b/CONTRIBUTING.d/patches/patches index c1a9ebc48..e84520b0c 100644 --- a/CONTRIBUTING.d/patches/patches +++ b/CONTRIBUTING.d/patches/patches @@ -20,49 +20,10 @@ Description To make your patch even more useful, please note the following points: - - Sign your patch with "Signed-off-by:". Read about the - "Developer's Certificate of Origin" at - . - When appropriate, other tags documented in that file, such as - "Reported-by:", "Reviewed-by:", "Acked-by:", and - "Suggested-by:" can be added to the patch. The man-pages - project also uses a "Cowritten-by:" tag with the obvious - meaning. Example: - - Signed-off-by: Alejandro Colomar - - - Describe how you obtained the information in your patch. For - example, was it: - - - by reading (or writing) the relevant kernel or (g)libc - source code? Please provide a pointer to the relevant - code. - - - from a commit message in the kernel or (g)libc source code - repository? Please provide a commit ID. - - - by writing a test program? Send it with the patch, but - please make sure it's as simple as possible, and provide - instructions on how to use it and/or a demo run. - - - from a standards document? Please name the standard, and - quote the relevant text. - - - from other documentation? Please provide a pointer to that - documentation. - - - from a mailing list or online forum? Please provide a URL - if possible. - - Send patches in diff -u format in an email patch. You may find it useful to employ git-format-patch(1) and git-send-email(1). - - Where relevant, include source code comments that cite commit - hashes for relevant kernel or glibc changes: - - .\" linux.git commit <40-character-git-hash> - - Send logically separate patches. For unrelated pages, or for logically-separate issues in the same page, send separate emails.