[Buildroot] [PATCH 3/3] docs/manual: document hashes for license files
Yann E. MORIN
yann.morin.1998 at free.fr
Sun Jun 18 08:01:06 UTC 2017
Signed-off-by: "Yann E. MORIN" <yann.morin.1998 at free.fr>
Cc: Thomas De Schampheleire <patrickdepinguin at gmail.com>
Cc: Luca Ceresoli <luca at lucaceresoli.net>
Cc: Rahul Bedarkar <rahulbedarkar89 at gmail.com>
Cc: Peter Korsgaard <peter at korsgaard.com>
---
docs/manual/adding-packages-directory.txt | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
index 08f5d42f91..5007d5368d 100644
--- a/docs/manual/adding-packages-directory.txt
+++ b/docs/manual/adding-packages-directory.txt
@@ -443,7 +443,7 @@ Optionally, you can add a third file, named +libfoo.hash+, that contains
the hashes of the downloaded files for the +libfoo+ package.
The hashes stored in that file are used to validate the integrity of the
-downloaded files.
+downloaded files and of the license files.
The format of this file is one line for each file for which to check the
hash, each line being space-separated, with these three fields:
@@ -458,7 +458,10 @@ hash, each line being space-separated, with these three fields:
** for +sha256+, 64 hexadecimal characters
** for +sha384+, 96 hexadecimal characters
** for +sha512+, 128 hexadecimal characters
-* the name of the file, without any directory component
+* the name of the file:
+** for a source archive: the basename of the file, without any directory
+ component,
+** for a license file: the path as it appears in +FOO_LICENSE_FILES+.
Lines starting with a +#+ sign are considered comments, and ignored. Empty
lines are ignored.
@@ -476,6 +479,11 @@ strong hash yourself (preferably +sha256+, but not +md5+), and mention
this in a comment line above the hashes.
.Note
+The hashes for license files are used to detect a license change when a
+package version is bumped, so a (relatively) weak hash like +sha1+ is
+enough for license files.
+
+.Note
The number of spaces does not matter, so one can use spaces (or tabs) to
properly align the different fields.
@@ -501,6 +509,10 @@ sha256 ff52101fb90bbfc3fe9475e425688c660f46216d7e751c4bbdb1dc85cdccacb9 libfoo-f
# No hash for 1234:
none xxx libfoo-1234.tar.gz
+
+# Hash for license files:
+sha1 c47a888f2be626e1197b6f651dee966ef882077d COPYING
+sha1 e101765734390d664b59325b2d644d80d9a6bd9a doc/COPYING.LGPL
----
If the +.hash+ file is present, and it contains one or more hashes for a
--
2.11.0
More information about the buildroot
mailing list