| Message ID | 20231121195854.27968-1-jsbronder@cold-front.org |
|---|---|
| State | New |
| Headers | show |
| Series | contributor-guide: add License-Update tag | expand |
Hi Justin, Many thanks for this improvement to the docs. On 21.11.23 at 20:58, Justin Bronder wrote: > Porting from the old wiki > https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935#Describing_license_changes > > Signed-off-by: Justin Bronder <jsbronder@cold-front.org> > --- > .../contributor-guide/recipe-style-guide.rst | 11 +++++++++++ > 1 file changed, 11 insertions(+) > > diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst > index a005aa324..bb8f6980e 100644 > --- a/documentation/contributor-guide/recipe-style-guide.rst > +++ b/documentation/contributor-guide/recipe-style-guide.rst > @@ -250,6 +250,17 @@ Recipes need to define both the :term:`LICENSE` and > correct string that you can substitute into the recipe file for a > subsequent build. > > +License Updates > ++++++++++++++++ I just replaced "++++..." by "~~~~..." as recommended in documentation/README and used in other parts of the manual, though the result looks the same to create a subsection. Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Merged into "master-next". Thanks again Michael.
diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst index a005aa324..bb8f6980e 100644 --- a/documentation/contributor-guide/recipe-style-guide.rst +++ b/documentation/contributor-guide/recipe-style-guide.rst @@ -250,6 +250,17 @@ Recipes need to define both the :term:`LICENSE` and correct string that you can substitute into the recipe file for a subsequent build. +License Updates ++++++++++++++++ +When you change the :term:`LICENSE` or :term:`LIC_FILES_CHKSUM` in the recipe +you need to briefly explain the reason for the change via a ``License-Update:`` +tag. Often it's quite trivial, such as:: + + License-Update: copyright years refreshed + +Less often, the actual licensing terms themselves will have changed. If so, do +try to link to upstream making/justifying that decision. + Tips and Guidelines for Writing Recipes ---------------------------------------
Porting from the old wiki https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935#Describing_license_changes Signed-off-by: Justin Bronder <jsbronder@cold-front.org> --- .../contributor-guide/recipe-style-guide.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)