ref-manual: Updated note about included failed license check

Fixes [YOCTO #10898]

It is hard to get the exact start and end for included license text
during a LIC_FILES_CHKSUM operation.  I updated the notes indicating
that the QA message returned upon failure includes the attempted
license text.  The user can better adjust his LIC_FILES_CHKSUM
statement to then dig out the proper text.

(From yocto-docs rev: 1db04334703f35f1cab933c345fb1db43fd0af79)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
index 61f55bd80a2e4441d9c30033504ffd616ce904e5..5712249ba423fa1d5fb7cf40edac0a6171bbc1f4 100644 (file)
--- a/documentation/ref-manual/technical-details.xml
+++ b/documentation/ref-manual/technical-details.xml
@@ -1455,12 +1455,22 @@
                          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><title>Notes</title>
+                    <itemizedlist>
+                        <listitem><para>
+                            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>.
+                            </para></listitem>
+                        <listitem><para>
+                            When a license check fails, the selected license
+                            text is included as part of the QA message.
+                            Using this output, you can determine the exact
+                            start and finish for the needed license text.
+                            </para></listitem>
+                    </itemizedlist>
                 </note>
             </para>