summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-05-31 10:10:20 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-06-15 11:26:46 +0100
commit73c7e9d229942fca26faba7df90d014e60e0dc72 (patch)
tree20e43f9582eb7d82ed715a328f4157ec923ba261
parent290809334ac6647baa52d455bfac233e6bf48e2d (diff)
downloadpoky-73c7e9d229942fca26faba7df90d014e60e0dc72.tar.gz
sdk-manual: Edits to "License Detection"
Updates to prose for better understanding. (From yocto-docs rev: 44a07560845c973a0da4c27969c740d3d712d323) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/sdk-manual/sdk-extensible.xml31
1 files changed, 17 insertions, 14 deletions
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml
index 2c4b5b99d7..c39951c181 100644
--- a/documentation/sdk-manual/sdk-extensible.xml
+++ b/documentation/sdk-manual/sdk-extensible.xml
@@ -1157,20 +1157,24 @@
1157 <para> 1157 <para>
1158 The <filename>devtool add</filename> command attempts to 1158 The <filename>devtool add</filename> command attempts to
1159 determine if the software you are adding is able to be 1159 determine if the software you are adding is able to be
1160 distributed under a common open-source license and sets the 1160 distributed under a common, open-source license.
1161 If so, the command sets the
1161 <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE'><filename>LICENSE</filename></ulink> 1162 <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE'><filename>LICENSE</filename></ulink>
1162 value accordingly. 1163 value accordingly.
1163 You should double-check this value against the documentation 1164 You should double-check the value added by the command against
1164 or source files for the software you are building and update 1165 the documentation or source files for the software you are
1165 that <filename>LICENSE</filename> value if necessary. 1166 building and, if necessary, update that
1167 <filename>LICENSE</filename> value.
1166 </para> 1168 </para>
1167 1169
1168 <para> 1170 <para>
1169 The <filename>devtool add</filename> command also sets the 1171 The <filename>devtool add</filename> command also sets the
1170 <ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></ulink> 1172 <ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></ulink>
1171 value to point to all files that appear to be license-related. 1173 value to point to all files that appear to be license-related.
1172 However, license statements often appear in comments at the top 1174 Realize that license statements often appear in comments at
1173 of source files or within documentation. 1175 the top of source files or within the documentation.
1176 In such cases, the command does not recognize those license
1177 statements.
1174 Consequently, you might need to amend the 1178 Consequently, you might need to amend the
1175 <filename>LIC_FILES_CHKSUM</filename> variable to point to one 1179 <filename>LIC_FILES_CHKSUM</filename> variable to point to one
1176 or more of those comments if present. 1180 or more of those comments if present.
@@ -1184,14 +1188,13 @@
1184 1188
1185 <para> 1189 <para>
1186 If the <filename>devtool add</filename> command cannot 1190 If the <filename>devtool add</filename> command cannot
1187 determine licensing information, the 1191 determine licensing information, <filename>devtool</filename>
1188 <filename>LICENSE</filename> value is set to "CLOSED" and the 1192 sets the <filename>LICENSE</filename> value to "CLOSED" and
1189 <filename>LIC_FILES_CHKSUM</filename> value remains unset. 1193 leaves the <filename>LIC_FILES_CHKSUM</filename> value unset.
1190 This behavior allows you to continue with development but is 1194 This behavior allows you to continue with development even
1191 unlikely to be correct in all cases. 1195 though the settings are unlikely to be correct in all cases.
1192 Consequently, you should check the documentation or source 1196 You should check the documentation or source files for the
1193 files for the software you are building to determine the actual 1197 software you are building to determine the actual license.
1194 license.
1195 </para> 1198 </para>
1196 </section> 1199 </section>
1197 1200