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