summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexandre Truong <alexandre.truong@smile.fr>2024-06-06 09:54:15 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-06-16 22:48:18 +0100
commit0df9d22928cd5c5e0a6db7efb7a2480f29124bd5 (patch)
treec496044d13f453384d7d05385a8bcfb9b2a8835b
parent838ca52a741acbffd082435406ea44e833789a14 (diff)
downloadpoky-0df9d22928cd5c5e0a6db7efb7a2480f29124bd5.tar.gz
recipe style guide: add recommendation for patches without signature
>From discussion [0], the presence of git version signature at the end of patches has been questionned. To avoid a bit more noise, the setting git format.signature is added to the documentation and its use is recommended. [0]: https://lists.openembedded.org/g/openembedded-core/topic/106323318#msg199967 (From yocto-docs rev: 7da39b91a0f20cb7215d51e00c098f3dc13180fd) Signed-off-by: Alexandre Truong <alexandre.truong@smile.fr> Reviewed-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/contributor-guide/recipe-style-guide.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst
index 08d8fb4259..142c02db1f 100644
--- a/documentation/contributor-guide/recipe-style-guide.rst
+++ b/documentation/contributor-guide/recipe-style-guide.rst
@@ -409,3 +409,15 @@ This should be the header of patch that fixes :cve:`2015-8370` in GRUB2::
409 Upstream-Status: Backport [http://git.savannah.gnu.org/cgit/grub.git/commit/?id=451d80e52d851432e109771bb8febafca7a5f1f2] 409 Upstream-Status: Backport [http://git.savannah.gnu.org/cgit/grub.git/commit/?id=451d80e52d851432e109771bb8febafca7a5f1f2]
410 CVE: CVE-2015-8370 410 CVE: CVE-2015-8370
411 Signed-off-by: Joe Developer <joe.developer@example.com> 411 Signed-off-by: Joe Developer <joe.developer@example.com>
412
413Patch format
414============
415
416By default, patches created with ``git format-patch`` have a `Git` version signature at the end.
417To avoid having a `Git` signature at the end of generated or updated patches,
418you can use `Git` configuration settings::
419
420 git config --global format.signature ""
421
422.. note::
423 Patches generated or updated by ``devtool`` are created with no signature.