diff options
Diffstat (limited to 'documentation/ref-manual/eclipse/html/poky-ref-manual/usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax.html')
| -rw-r--r-- | documentation/ref-manual/eclipse/html/poky-ref-manual/usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax.html | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/documentation/ref-manual/eclipse/html/poky-ref-manual/usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax.html b/documentation/ref-manual/eclipse/html/poky-ref-manual/usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax.html deleted file mode 100644 index e702578a24..0000000000 --- a/documentation/ref-manual/eclipse/html/poky-ref-manual/usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax.html +++ /dev/null | |||
| @@ -1,58 +0,0 @@ | |||
| 1 | <html> | ||
| 2 | <head> | ||
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | ||
| 4 | <title>3.4.1.2. Explanation of Syntax</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="The Yocto Project Reference Manual"> | ||
| 8 | <link rel="up" href="usingpoky-configuring-LIC_FILES_CHKSUM.html" title="3.4.1. Tracking License Changes"> | ||
| 9 | <link rel="prev" href="usingpoky-specifying-LIC_FILES_CHKSUM.html" title="3.4.1.1. Specifying the LIC_FILES_CHKSUM Variable"> | ||
| 10 | <link rel="next" href="enabling-commercially-licensed-recipes.html" title="3.4.2. Enabling Commercially Licensed Recipes"> | ||
| 11 | </head> | ||
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="section" title="3.4.1.2. Explanation of Syntax"> | ||
| 13 | <div class="titlepage"><div><div><h4 class="title"> | ||
| 14 | <a name="usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax"></a>3.4.1.2. Explanation of Syntax</h4></div></div></div> | ||
| 15 | <p> | ||
| 16 | As mentioned in the previous section, the | ||
| 17 | <code class="filename">LIC_FILES_CHKSUM</code> variable lists all the | ||
| 18 | important files that contain the license text for the source code. | ||
| 19 | It is possible to specify a checksum for an entire file, or a specific section of a | ||
| 20 | file (specified by beginning and ending line numbers with the "beginline" and "endline" | ||
| 21 | parameters, respectively). | ||
| 22 | The latter is useful for source files with a license notice header, | ||
| 23 | README documents, and so forth. | ||
| 24 | If you do not use the "beginline" parameter, then it is assumed that the text begins on the | ||
| 25 | first line of the file. | ||
| 26 | Similarly, if you do not use the "endline" parameter, it is assumed that the license text | ||
| 27 | ends with the last line of the file. | ||
| 28 | </p> | ||
| 29 | <p> | ||
| 30 | The "md5" parameter stores the md5 checksum of the license text. | ||
| 31 | If the license text changes in any way as compared to this parameter | ||
| 32 | then a mismatch occurs. | ||
| 33 | This mismatch triggers a build failure and notifies the developer. | ||
| 34 | Notification allows the developer to review and address the license text changes. | ||
| 35 | Also note that if a mismatch occurs during the build, the correct md5 | ||
| 36 | checksum is placed in the build log and can be easily copied to the recipe. | ||
| 37 | </p> | ||
| 38 | <p> | ||
| 39 | There is no limit to how many files you can specify using the | ||
| 40 | <code class="filename">LIC_FILES_CHKSUM</code> variable. | ||
| 41 | Generally, however, every project requires a few specifications for license tracking. | ||
| 42 | Many projects have a "COPYING" file that stores the license information for all the source | ||
| 43 | code files. | ||
| 44 | This practice allows you to just track the "COPYING" file as long as it is kept up to date. | ||
| 45 | </p> | ||
| 46 | <div class="tip" title="Tip" style="margin-left: 0.5in; margin-right: 0.5in;"> | ||
| 47 | <h3 class="title">Tip</h3> | ||
| 48 | If you specify an empty or invalid "md5" parameter, BitBake returns an md5 mis-match | ||
| 49 | error and displays the correct "md5" parameter value during the build. | ||
| 50 | The correct parameter is also captured in the build log. | ||
| 51 | </div> | ||
| 52 | <div class="tip" title="Tip" style="margin-left: 0.5in; margin-right: 0.5in;"> | ||
| 53 | <h3 class="title">Tip</h3> | ||
| 54 | If the whole file contains only license text, you do not need to use the "beginline" and | ||
| 55 | "endline" parameters. | ||
| 56 | </div> | ||
| 57 | </div></body> | ||
| 58 | </html> | ||