mirror/buildroot
1
0
Fork 0
mirror of https://gitlab.com/buildroot.org/buildroot.git synced 2026-09-09 07:51:59 -09:00
Code Issues Packages Projects Releases Wiki Activity

docs/manual/contribute.adoc: mention license file changes in commit message

Browse Source 
It has been good practice for a while to describe the kind of change
in the commit message of any patch that changes license file
hashes. This is important so any substantial changes don't go
unnoticed. However it wasn't explicitly stated in the manual, fix
that.

Signed-off-by: Fiona Klute <fiona.klute@gmx.de>
Signed-off-by: Julien Olivain <ju.o@free.fr>
(cherry picked from commit ef655b53dd)
Signed-off-by: Titouan Christophe <titouan.christophe@mind.be>
This commit is contained in:
Fiona Klute
2026-08-07 22:24:57 +02:00
committed by Titouan Christophe
parent 3a1681c01e
commit b8230dfa8a
1 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/manual/contribute.adoc
View File

@@ -283,16 +283,18 @@ the commit message body.
When you bump a package to a new version, you should also submit a
separate patch for each package. Don't forget to update the +.hash+
file, or add it if it doesn't exist yet. Also don't forget to check if
the +_LICENSE+ and +_LICENSE_FILES+ are still valid. The summary line
should be something like +<packagename>: bump to version <new
version>+. If the new version only contains security updates compared
to the existing one, the summary should be +<packagename>: security
bump to version <new version>+ and the commit message body should show
the CVE numbers that are fixed. If some package patches can be removed
in the new version, it should be explained explicitly why they can be
removed, preferably with the upstream commit ID. Also any other
required changes should be explained explicitly, like configure
options that no longer exist or are no longer needed.
the +_LICENSE+ and +_LICENSE_FILES+ are still valid. If the hash of a
license file changed, please include a note in the commit message
about what changed, ideally with a link to the upstream commit. The
summary line should be something like +<packagename>: bump to version
<new version>+. If the new version only contains security updates
compared to the existing one, the summary should be +<packagename>:
security bump to version <new version>+ and the commit message body
should show the CVE numbers that are fixed. If some package patches
can be removed in the new version, it should be explained explicitly
why they can be removed, preferably with the upstream commit ID. Also
any other required changes should be explained explicitly, like
configure options that no longer exist or are no longer needed.
If you are interested in getting notified of build failures and of
further changes in the packages you added or modified, please add