ref-manual: Updated LIC_FILES_CHKSUM example

Fixes [YOCTO #10898]

No information indicated the use of "endline" and "beginline"
in the examples setting LIC_FILES_CHKSUM.  I added a note
indicating that line numbering starts with one and the "endline"
value is inclusive.

(From yocto-docs rev: 21114f09efa423033da67af1f27c99eb3cb9695d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2017-01-10 15:32:30 -08:00 committed by Richard Purdie
parent 70b9668b26
commit f4b667cfbc
1 changed files with 13 additions and 3 deletions

View File

@ -1445,14 +1445,23 @@
<para>
The <filename>LIC_FILES_CHKSUM</filename>
variable contains checksums of the license text in the source code for the recipe.
Following is an example of how to specify <filename>LIC_FILES_CHKSUM</filename>:
variable contains checksums of the license text in the source
code for the recipe.
Following is an example of how to specify
<filename>LIC_FILES_CHKSUM</filename>:
<literallayout class='monospaced'>
LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \
file://licfile1.txt;beginline=5;endline=29;md5=yyyy \
file://licfile2.txt;endline=50;md5=zzzz \
..."
</literallayout>
<note>
When using "beginline" and "endline", realize that line
numbering begins with one and not zero.
Also, the lines included are inclusive (e.g. lines five
through 29 in the previous example for
<filename>licfile1.txt</filename>.
</note>
</para>
<para>
@ -1474,7 +1483,8 @@
<para>
The first line locates a file in
<filename>${S}/src/ls.c</filename>.
<filename>${S}/src/ls.c</filename> and isolates lines five
through 16 as license text.
The second line refers to a file in
<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>.
</para>