[ptxdist] [PATCH] doc: contributing: explain what to do if license checksums change

[ptxdist] [PATCH] doc: contributing: explain what to do if license checksums change

[Roland Hieber]

Inspired by the discussion in
https://lore.ptxdist.org/ptxdist/20240129100553.56125-1-artur@4wiebe.de

Cc: Artur Wiebe <artur@4wiebe.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 doc/contributing.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/contributing.rst b/doc/contributing.rst
index e4209480893d..63da67802222 100644
--- a/doc/contributing.rst
+++ b/doc/contributing.rst
@@ -139,6 +139,13 @@ in mind:
 -  Run ``ptxdist licensecheck [<pkg>]`` to make sure that the checksum of
    pinned-down license files haven't changed.
 
+   If the license file has changed, look at the difference between the old and
+   the new version of the file (e.g. by comparing the two versioned build
+   folders in ``platform-nnn/build-target/``), and update the package's
+   ``_LICENSE`` variable if necessary.
+   Often the difference is only in the copyright year, but in any case, describe
+   the changes in the license file when sending your patch!
+
 Misc
 ~~~~
 
-- 
2.39.2

Re: [ptxdist] [APPLIED] doc: contributing: explain what to do if license checksums change

[Michael Olbrich]

Thanks, applied as b14fb42f8aeedcb4cf1d5798c7bd92aa0f6b763b.

Michael

[sent from post-receive hook]

On Fri, 09 Feb 2024 17:11:31 +0100, Roland Hieber <rhi@pengutronix.de> wrote:
> Inspired by the discussion in
> https://lore.ptxdist.org/ptxdist/20240129100553.56125-1-artur@4wiebe.de
> 
> Cc: Artur Wiebe <artur@4wiebe.de>
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> Message-Id: <20240208095141.1031314-1-rhi@pengutronix.de>
> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
> 
> diff --git a/doc/contributing.rst b/doc/contributing.rst
> index e4209480893d..63da67802222 100644
> --- a/doc/contributing.rst
> +++ b/doc/contributing.rst
> @@ -139,6 +139,13 @@ in mind:
>  -  Run ``ptxdist licensecheck [<pkg>]`` to make sure that the checksum of
>     pinned-down license files haven't changed.
>  
> +   If the license file has changed, look at the difference between the old and
> +   the new version of the file (e.g. by comparing the two versioned build
> +   folders in ``platform-nnn/build-target/``), and update the package's
> +   ``_LICENSE`` variable if necessary.
> +   Often the difference is only in the copyright year, but in any case, describe
> +   the changes in the license file when sending your patch!
> +
>  Misc
>  ~~~~
>