diff options
Diffstat (limited to 'documentation/poky-ref-manual')
-rw-r--r-- | documentation/poky-ref-manual/extendpoky.xml | 42 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 10 |
2 files changed, 28 insertions, 24 deletions
diff --git a/documentation/poky-ref-manual/extendpoky.xml b/documentation/poky-ref-manual/extendpoky.xml index e624340f10..e804511bac 100644 --- a/documentation/poky-ref-manual/extendpoky.xml +++ b/documentation/poky-ref-manual/extendpoky.xml | |||
@@ -1006,13 +1006,14 @@ | |||
1006 | </section> | 1006 | </section> |
1007 | 1007 | ||
1008 | <section id="usingpoky-configuring-LIC_FILES_CHKSUM"> | 1008 | <section id="usingpoky-configuring-LIC_FILES_CHKSUM"> |
1009 | <title>Track License Change</title> | 1009 | <title>Tracking License Changes</title> |
1010 | 1010 | ||
1011 | <para> | 1011 | <para> |
1012 | The license of an upstream project might change in the future. | 1012 | The license of an upstream project might change in the future. In order to prevent these changes |
1013 | The Yocto Project uses the | 1013 | going unnoticed, the Yocto Project provides a |
1014 | <filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></filename> variable | 1014 | <glossterm><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></glossterm> |
1015 | to track license changes. | 1015 | variable to track changes to the license text. The checksums are validated at the end of the |
1016 | configure step, and if the checksums do not match, the build will fail. | ||
1016 | </para> | 1017 | </para> |
1017 | 1018 | ||
1018 | <section id="usingpoky-specifying-LIC_FILES_CHKSUM"> | 1019 | <section id="usingpoky-specifying-LIC_FILES_CHKSUM"> |
@@ -1020,14 +1021,12 @@ | |||
1020 | 1021 | ||
1021 | <para> | 1022 | <para> |
1022 | The <filename>LIC_FILES_CHKSUM</filename> | 1023 | The <filename>LIC_FILES_CHKSUM</filename> |
1023 | variable contains checksums of the license text in the recipe source code. | 1024 | variable contains checksums of the license text in the source code for the recipe. |
1024 | The Yocto Project uses checksums to track changes in the license text of the | 1025 | Following is an example of how to specify <filename>LIC_FILES_CHKSUM</filename>: |
1025 | source code files. | ||
1026 | Following is an example of <filename>LIC_FILES_CHKSUM</filename>: | ||
1027 | <literallayout class='monospaced'> | 1026 | <literallayout class='monospaced'> |
1028 | LIC_FILES_CHKSUM = "file://COPYING; md5=xxxx \ | 1027 | LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \ |
1029 | file://licfile1.txt; beginline=5; endline=29;md5=yyyy \ | 1028 | file://licfile1.txt;beginline=5;endline=29;md5=yyyy \ |
1030 | file://licfile2.txt; endline=50;md5=zzzz \ | 1029 | file://licfile2.txt;endline=50;md5=zzzz \ |
1031 | ..." | 1030 | ..." |
1032 | </literallayout> | 1031 | </literallayout> |
1033 | </para> | 1032 | </para> |
@@ -1056,6 +1055,10 @@ | |||
1056 | <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>, which is the parent | 1055 | <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>, which is the parent |
1057 | of <filename>S</filename>. | 1056 | of <filename>S</filename>. |
1058 | </para> | 1057 | </para> |
1058 | <para> | ||
1059 | Note that this variable is mandatory for all recipes, unless the LICENSE variable is set to | ||
1060 | "CLOSED". | ||
1061 | </para> | ||
1059 | </section> | 1062 | </section> |
1060 | 1063 | ||
1061 | <section id="usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax"> | 1064 | <section id="usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax"> |
@@ -1064,8 +1067,10 @@ | |||
1064 | As mentioned in the previous section, the | 1067 | As mentioned in the previous section, the |
1065 | <filename>LIC_FILES_CHKSUM</filename> variable lists all the | 1068 | <filename>LIC_FILES_CHKSUM</filename> variable lists all the |
1066 | important files that contain the license text for the source code. | 1069 | important files that contain the license text for the source code. |
1067 | Using this variable, you can specify the line on which the license text starts and ends | 1070 | It is possible to specify a checksum for an entire file, or a specific section of a |
1068 | by supplying "beginline" and "endline" parameters. | 1071 | file (specified by beginning and ending line numbers with the "beginline" and "endline" |
1072 | parameters respectively). The latter is useful for source files with license notice header, | ||
1073 | README documents, etc. | ||
1069 | If you do not use the "beginline" parameter, then it is assumed that the text begins on the | 1074 | If you do not use the "beginline" parameter, then it is assumed that the text begins on the |
1070 | first line of the file. | 1075 | first line of the file. |
1071 | Similarly, if you do not use the "endline" parameter, it is assumed that the license text | 1076 | Similarly, if you do not use the "endline" parameter, it is assumed that the license text |
@@ -1075,12 +1080,11 @@ | |||
1075 | <para> | 1080 | <para> |
1076 | The "md5" parameter stores the md5 checksum of the license text. | 1081 | The "md5" parameter stores the md5 checksum of the license text. |
1077 | If the license text changes in any way as compared to this parameter | 1082 | If the license text changes in any way as compared to this parameter |
1078 | then a mis-match occurs. | 1083 | then a mismatch occurs. |
1079 | This mismatch triggers a build failure and notifies the developer. | 1084 | This mismatch triggers a build failure and notifies the developer. |
1080 | Notification allows the developer to review and address the license text changes. | 1085 | Notification allows the developer to review and address the license text changes. |
1081 | Also note that if a mis-match occurs during the build, the correct md5 | 1086 | Also note that if a mismatch occurs during the build, the correct md5 |
1082 | checksum is placed in the build log and can be easily copied to a | 1087 | checksum is placed in the build log and can be easily copied to the recipe. |
1083 | <filename>.bb</filename> file. | ||
1084 | </para> | 1088 | </para> |
1085 | 1089 | ||
1086 | <para> | 1090 | <para> |
@@ -1089,7 +1093,7 @@ | |||
1089 | Generally, however, every project requires a few specifications for license tracking. | 1093 | Generally, however, every project requires a few specifications for license tracking. |
1090 | Many projects have a "COPYING" file that stores the license information for all the source | 1094 | Many projects have a "COPYING" file that stores the license information for all the source |
1091 | code files. | 1095 | code files. |
1092 | This practice allow you to just track the "COPYING" file as long as it is kept up to date. | 1096 | This practice allows you to just track the "COPYING" file as long as it is kept up to date. |
1093 | </para> | 1097 | </para> |
1094 | 1098 | ||
1095 | <tip> | 1099 | <tip> |
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 81dbf0c1ca..3dd9183bcf 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml | |||
@@ -562,12 +562,12 @@ | |||
562 | <para>Checksums of the license text in the recipe source code.</para> | 562 | <para>Checksums of the license text in the recipe source code.</para> |
563 | <para>This variable tracks changes in license text of the source | 563 | <para>This variable tracks changes in license text of the source |
564 | code files. | 564 | code files. |
565 | If the license text is changed, it will trigger the build | 565 | If the license text is changed, it will trigger a build |
566 | failure, which gives the developer an opportunity to review any | 566 | failure, which gives the developer an opportunity to review any |
567 | license change</para> | 567 | license change.</para> |
568 | <para> | 568 | <para> |
569 | Currently, this variable is optional. | 569 | This variable must be defined for all recipes (unless LICENSE |
570 | The plan is to make it a required variable in the future.</para> | 570 | is set to "CLOSED")</para> |
571 | <para>For more information, see the | 571 | <para>For more information, see the |
572 | <link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'> | 572 | <link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'> |
573 | Track License Change</link> section</para> | 573 | Track License Change</link> section</para> |