diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-01-29 15:18:03 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-02-14 15:25:29 +0000 |
commit | ae06e04cd225d2c2147ca355e2dd39b4f6cf6775 (patch) | |
tree | c920e85262a91e7626279e7dcbbd56a299919f49 /documentation/getting-started/eclipse/html/getting-started/usingpoky-specifying-LIC_FILES_CHKSUM.html | |
parent | ebc7de094881dd8f2450aa4fdf548f2e9c835df1 (diff) | |
download | poky-ae06e04cd225d2c2147ca355e2dd39b4f6cf6775.tar.gz |
documentation: Created new "Getting Started" manual.
Creation involved removing the overview-manual and replacing it
with the getting-started manual. All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".
The style sheet for the new manual needed updating to display the
new .PNG image for the title page. The mega-manual file had to
be updated to include the files. The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.
(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/getting-started/eclipse/html/getting-started/usingpoky-specifying-LIC_FILES_CHKSUM.html')
-rw-r--r-- | documentation/getting-started/eclipse/html/getting-started/usingpoky-specifying-LIC_FILES_CHKSUM.html | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/documentation/getting-started/eclipse/html/getting-started/usingpoky-specifying-LIC_FILES_CHKSUM.html b/documentation/getting-started/eclipse/html/getting-started/usingpoky-specifying-LIC_FILES_CHKSUM.html new file mode 100644 index 0000000000..ed9a3cc501 --- /dev/null +++ b/documentation/getting-started/eclipse/html/getting-started/usingpoky-specifying-LIC_FILES_CHKSUM.html | |||
@@ -0,0 +1,82 @@ | |||
1 | <html> | ||
2 | <head> | ||
3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | ||
4 | <title>3.7.1.1. Specifying the LIC_FILES_CHKSUM Variable</title> | ||
5 | <link rel="stylesheet" type="text/css" href="../book.css"> | ||
6 | <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> | ||
7 | <link rel="home" href="index.html" title="Getting Started With Yocto Project"> | ||
8 | <link rel="up" href="usingpoky-configuring-LIC_FILES_CHKSUM.html" title="3.7.1. Tracking License Changes"> | ||
9 | <link rel="prev" href="usingpoky-configuring-LIC_FILES_CHKSUM.html" title="3.7.1. Tracking License Changes"> | ||
10 | <link rel="next" href="usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax.html" title="3.7.1.2. Explanation of Syntax"> | ||
11 | </head> | ||
12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="section" title="3.7.1.1. Specifying the LIC_FILES_CHKSUM Variable"> | ||
13 | <div class="titlepage"><div><div><h4 class="title"> | ||
14 | <a name="usingpoky-specifying-LIC_FILES_CHKSUM"></a>3.7.1.1. Specifying the <code class="filename">LIC_FILES_CHKSUM</code> Variable</h4></div></div></div> | ||
15 | <p> | ||
16 | The <code class="filename">LIC_FILES_CHKSUM</code> | ||
17 | variable contains checksums of the license text in the | ||
18 | source code for the recipe. | ||
19 | Following is an example of how to specify | ||
20 | <code class="filename">LIC_FILES_CHKSUM</code>: | ||
21 | </p> | ||
22 | <pre class="literallayout"> | ||
23 | LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \ | ||
24 | file://licfile1.txt;beginline=5;endline=29;md5=yyyy \ | ||
25 | file://licfile2.txt;endline=50;md5=zzzz \ | ||
26 | ..." | ||
27 | </pre> | ||
28 | <p> | ||
29 | </p> | ||
30 | <div class="note" title="Notes" style="margin-left: 0.5in; margin-right: 0.5in;"> | ||
31 | <h3 class="title">Notes</h3> | ||
32 | <div class="itemizedlist"><ul class="itemizedlist" type="disc"> | ||
33 | <li class="listitem"><p> | ||
34 | When using "beginline" and "endline", realize | ||
35 | that line numbering begins with one and not | ||
36 | zero. | ||
37 | Also, the included lines are inclusive (i.e. | ||
38 | lines five through and including 29 in the | ||
39 | previous example for | ||
40 | <code class="filename">licfile1.txt</code>). | ||
41 | </p></li> | ||
42 | <li class="listitem"><p> | ||
43 | When a license check fails, the selected license | ||
44 | text is included as part of the QA message. | ||
45 | Using this output, you can determine the exact | ||
46 | start and finish for the needed license text. | ||
47 | </p></li> | ||
48 | </ul></div> | ||
49 | </div> | ||
50 | <p> | ||
51 | </p> | ||
52 | <p> | ||
53 | The build system uses the | ||
54 | <a class="link" href="../ref-manual/var-S.html" target="_self"><code class="filename">S</code></a> | ||
55 | variable as the default directory when searching files | ||
56 | listed in <code class="filename">LIC_FILES_CHKSUM</code>. | ||
57 | The previous example employs the default directory. | ||
58 | </p> | ||
59 | <p> | ||
60 | Consider this next example: | ||
61 | </p> | ||
62 | <pre class="literallayout"> | ||
63 | LIC_FILES_CHKSUM = "file://src/ls.c;beginline=5;endline=16;\ | ||
64 | md5=bb14ed3c4cda583abc85401304b5cd4e" | ||
65 | LIC_FILES_CHKSUM = "file://${WORKDIR}/license.html;md5=5c94767cedb5d6987c902ac850ded2c6" | ||
66 | </pre> | ||
67 | <p> | ||
68 | </p> | ||
69 | <p> | ||
70 | The first line locates a file in | ||
71 | <code class="filename">${S}/src/ls.c</code> and isolates lines five | ||
72 | through 16 as license text. | ||
73 | The second line refers to a file in | ||
74 | <a class="link" href="../ref-manual/var-WORKDIR.html" target="_self"><code class="filename">WORKDIR</code></a>. | ||
75 | </p> | ||
76 | <p> | ||
77 | Note that <code class="filename">LIC_FILES_CHKSUM</code> variable is | ||
78 | mandatory for all recipes, unless the | ||
79 | <code class="filename">LICENSE</code> variable is set to "CLOSED". | ||
80 | </p> | ||
81 | </div></body> | ||
82 | </html> | ||