Message ID | 20240530134950.14465-1-alexandre.truong@smile.fr |
---|---|
State | New, archived |
Headers | show |
Series | recipe style guide: add recommendation for patches without signature | expand |
Hi Alexandre Many thanks for the patch! I just have minor improvements to suggest... On 5/30/24 15:49, Alexandre Truong 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..01419a17a 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. Here, you should use `Git`. See https://git.yoctoproject.org/yocto-docs/tree/documentation/standards.md#n79 . That's a new rule, that's not enforced yet, but I will submit patches to make the change everywhere. > +To avoid having a git signature at the end of generated or updated patches, > +you can use Git configuration settings:: Same here in the above two lines. > + > + git config --global format.signature "" > + > +.. note:: > + Patches generated or updated by devtool are created with no signature. Here, you should use ``devtool`` as in the rest of the docs. Here we consider we refer to the command name. Thanks in advance for the update. Cheers Michael. >
Hi Michael, Thanks for your feedback, I will make the changes and send a v2. Alexandre Le mer. 5 juin 2024 à 18:21, Michael Opdenacker <michael@opdenacker.org> a écrit : > Hi Alexandre > > Many thanks for the patch! > I just have minor improvements to suggest... > > On 5/30/24 15:49, Alexandre Truong 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..01419a17a 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. > > Here, you should use `Git`. See > https://git.yoctoproject.org/yocto-docs/tree/documentation/standards.md#n79 > . That's a new rule, that's not enforced yet, but I will submit patches > to make the change everywhere. > > > +To avoid having a git signature at the end of generated or updated > patches, > > +you can use Git configuration settings:: > > Same here in the above two lines. > > > + > > + git config --global format.signature "" > > + > > +.. note:: > > + Patches generated or updated by devtool are created with no > signature. > > Here, you should use ``devtool`` as in the rest of the docs. Here we > consider we refer to the command name. > > Thanks in advance for the update. > Cheers > Michael. > > > > >
diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst index 08d8fb425..01419a17a 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.