| Message ID | 20240606075415.6666-1-alexandre.truong@smile.fr |
|---|---|
| State | New |
| Headers | show |
| Series | [v2] recipe style guide: add recommendation for patches without signature | expand |
Hi Alexandre Many thanks for the update! On 6/6/24 09:54, Alexandre Truong via lists.yoctoproject.org wrote: > 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 > > Signed-off-by: Alexandre Truong <alexandre.truong@smile.fr> > Reviewed-by: Yoann Congal <yoann.congal@smile.fr> > --- > .../contributor-guide/recipe-style-guide.rst | 12 ++++++++++++ > 1 file changed, 12 insertions(+) > > diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst > index 08d8fb425..142c02db1 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:: > Upstream-Status: Backport [http://git.savannah.gnu.org/cgit/grub.git/commit/?id=451d80e52d851432e109771bb8febafca7a5f1f2] > CVE: CVE-2015-8370 > Signed-off-by: Joe Developer <joe.developer@example.com> > + > +Patch format > +============ > + > +By default, patches created with ``git format-patch`` have a `Git` version signature at the end. > +To avoid having a `Git` signature at the end of generated or updated patches, > +you can use `Git` configuration settings:: > + > + git config --global format.signature "" > + > +.. note:: > + Patches generated or updated by ``devtool`` are created with no signature. Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Cheers Michael.
diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst index 08d8fb425..142c02db1 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:: Upstream-Status: Backport [http://git.savannah.gnu.org/cgit/grub.git/commit/?id=451d80e52d851432e109771bb8febafca7a5f1f2] CVE: CVE-2015-8370 Signed-off-by: Joe Developer <joe.developer@example.com> + +Patch format +============ + +By default, patches created with ``git format-patch`` have a `Git` version signature at the end. +To avoid having a `Git` signature at the end of generated or updated patches, +you can use `Git` configuration settings:: + + git config --global format.signature "" + +.. note:: + Patches generated or updated by ``devtool`` are created with no signature.