summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-06-14 16:31:16 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-06-22 09:16:43 +0100
commit912d73d42b93a44b85769ee22c54390a0c75bbb5 (patch)
treeef474d113dd4d50d34f2e0024b0afc390bfbbe6c /documentation
parentba34d31ed97cd5b32512efddd93b8a2194b6e35f (diff)
downloadpoky-912d73d42b93a44b85769ee22c54390a0c75bbb5.tar.gz
dev-manual, ref-manual: Moved "Licenses" section to ref-manual
Fixes [YOCTO #11630] Moved the "Licenses" section from the dev-manual to the ref-manual. The information in the section is purely reference material and does not belong in the dev-manual, which is being reconstructed as a "how-to" manual. (From yocto-docs rev: a89cb18f6cab6702a2bf2a0f77d46e64f82b1729) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml78
-rw-r--r--documentation/ref-manual/faq.xml2
-rw-r--r--documentation/ref-manual/ref-development-environment.xml86
3 files changed, 87 insertions, 79 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index a881295ce0..aca292063e 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -317,7 +317,7 @@
317 Separate the project's Metadata and code by using 317 Separate the project's Metadata and code by using
318 separate Git repositories. 318 separate Git repositories.
319 See the 319 See the
320 "<ulink url='&YOCTO_DOC_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" 320 "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
321 section for information on these repositories. 321 section for information on these repositories.
322 See the 322 See the
323 "<link linkend='getting-setup'>Getting Set Up</link>" 323 "<link linkend='getting-setup'>Getting Set Up</link>"
@@ -354,82 +354,6 @@
354 </section> 354 </section>
355</section> 355</section>
356 356
357<section id='licensing'>
358 <title>Licensing</title>
359
360 <para>
361 Because open source projects are open to the public, they have different licensing structures in place.
362 License evolution for both Open Source and Free Software has an interesting history.
363 If you are interested in this history, you can find basic information here:
364 <itemizedlist>
365 <listitem><para><ulink url='http://en.wikipedia.org/wiki/Open-source_license'>Open source license history</ulink>
366 </para></listitem>
367 <listitem><para><ulink url='http://en.wikipedia.org/wiki/Free_software_license'>Free software license
368 history</ulink></para></listitem>
369 </itemizedlist>
370 </para>
371
372 <para>
373 In general, the Yocto Project is broadly licensed under the Massachusetts Institute of Technology
374 (MIT) License.
375 MIT licensing permits the reuse of software within proprietary software as long as the
376 license is distributed with that software.
377 MIT is also compatible with the GNU General Public License (GPL).
378 Patches to the Yocto Project follow the upstream licensing scheme.
379 You can find information on the MIT license
380 <ulink url='http://www.opensource.org/licenses/mit-license.php'>here</ulink>.
381 You can find information on the GNU GPL <ulink url='http://www.opensource.org/licenses/LGPL-3.0'>
382 here</ulink>.
383 </para>
384
385 <para>
386 When you build an image using the Yocto Project, the build process uses a
387 known list of licenses to ensure compliance.
388 You can find this list in the
389 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> at
390 <filename>meta/files/common-licenses</filename>.
391 Once the build completes, the list of all licenses found and used during that build are
392 kept in the
393 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
394 at <filename>tmp/deploy/licenses</filename>.
395 </para>
396
397 <para>
398 If a module requires a license that is not in the base list, the build process
399 generates a warning during the build.
400 These tools make it easier for a developer to be certain of the licenses with which
401 their shipped products must comply.
402 However, even with these tools it is still up to the developer to resolve potential licensing issues.
403 </para>
404
405 <para>
406 The base list of licenses used by the build process is a combination of the Software Package
407 Data Exchange (SPDX) list and the Open Source Initiative (OSI) projects.
408 <ulink url='http://spdx.org'>SPDX Group</ulink> is a working group of the Linux Foundation
409 that maintains a specification
410 for a standard format for communicating the components, licenses, and copyrights
411 associated with a software package.
412 <ulink url='http://opensource.org'>OSI</ulink> is a corporation dedicated to the Open Source
413 Definition and the effort for reviewing and approving licenses that
414 conform to the Open Source Definition (OSD).
415 </para>
416
417 <para>
418 You can find a list of the combined SPDX and OSI licenses that the
419 Yocto Project uses in the
420 <filename>meta/files/common-licenses</filename> directory in your
421 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
422 </para>
423
424 <para>
425 For information that can help you maintain compliance with various
426 open source licensing during the lifecycle of a product created using
427 the Yocto Project, see the
428 "<link linkend='maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</link>"
429 section.
430 </para>
431</section>
432
433<section id='git'> 357<section id='git'>
434 <title>Git</title> 358 <title>Git</title>
435 359
diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml
index c4b860b1ce..55a6a89ad7 100644
--- a/documentation/ref-manual/faq.xml
+++ b/documentation/ref-manual/faq.xml
@@ -416,7 +416,7 @@
416 416
417 <para> 417 <para>
418 You can find more information on licensing in the 418 You can find more information on licensing in the
419 "<ulink url='&YOCTO_DOCS_DEV_URL;#licensing'>Licensing</ulink>" 419 "<ulink url='&YOCTO_DOCS_REF_URL;#licensing'>Licensing</ulink>"
420 and "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" 420 and "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>"
421 sections, both of which are in the Yocto Project Development 421 sections, both of which are in the Yocto Project Development
422 Manual. 422 Manual.
diff --git a/documentation/ref-manual/ref-development-environment.xml b/documentation/ref-manual/ref-development-environment.xml
index 6d4a76792e..5b0557d905 100644
--- a/documentation/ref-manual/ref-development-environment.xml
+++ b/documentation/ref-manual/ref-development-environment.xml
@@ -99,7 +99,7 @@
99 <link linkend='source-directory'>Source Directory</link> 99 <link linkend='source-directory'>Source Directory</link>
100 and the files for supported BSPs 100 and the files for supported BSPs
101 (e.g., <filename>meta-intel</filename>) is to use 101 (e.g., <filename>meta-intel</filename>) is to use
102 <link linkend='git'>Git</link> to create a local copy of 102 <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> to create a local copy of
103 the upstream repositories. 103 the upstream repositories.
104 </para></listitem> 104 </para></listitem>
105 <listitem><para> 105 <listitem><para>
@@ -166,6 +166,90 @@
166 </para> 166 </para>
167</section> 167</section>
168 168
169<section id='licensing'>
170 <title>Licensing</title>
171
172 <para>
173 Because open source projects are open to the public, they have
174 different licensing structures in place.
175 License evolution for both Open Source and Free Software has an
176 interesting history.
177 If you are interested in this history, you can find basic information
178 here:
179 <itemizedlist>
180 <listitem><para>
181 <ulink url='http://en.wikipedia.org/wiki/Open-source_license'>Open source license history</ulink>
182 </para></listitem>
183 <listitem><para>
184 <ulink url='http://en.wikipedia.org/wiki/Free_software_license'>Free software license history</ulink>
185 </para></listitem>
186 </itemizedlist>
187 </para>
188
189 <para>
190 In general, the Yocto Project is broadly licensed under the
191 Massachusetts Institute of Technology (MIT) License.
192 MIT licensing permits the reuse of software within proprietary
193 software as long as the license is distributed with that software.
194 MIT is also compatible with the GNU General Public License (GPL).
195 Patches to the Yocto Project follow the upstream licensing scheme.
196 You can find information on the MIT license
197 <ulink url='http://www.opensource.org/licenses/mit-license.php'>here</ulink>.
198 You can find information on the GNU GPL
199 <ulink url='http://www.opensource.org/licenses/LGPL-3.0'>here</ulink>.
200 </para>
201
202 <para>
203 When you build an image using the Yocto Project, the build process
204 uses a known list of licenses to ensure compliance.
205 You can find this list in the
206 <link linkend='source-directory'>Source Directory</link> at
207 <filename>meta/files/common-licenses</filename>.
208 Once the build completes, the list of all licenses found and used
209 during that build are kept in the
210 <link linkend='build-directory'>Build Directory</link>
211 at <filename>tmp/deploy/licenses</filename>.
212 </para>
213
214 <para>
215 If a module requires a license that is not in the base list, the
216 build process generates a warning during the build.
217 These tools make it easier for a developer to be certain of the
218 licenses with which their shipped products must comply.
219 However, even with these tools it is still up to the developer to
220 resolve potential licensing issues.
221 </para>
222
223 <para>
224 The base list of licenses used by the build process is a combination
225 of the Software Package Data Exchange (SPDX) list and the Open
226 Source Initiative (OSI) projects.
227 <ulink url='http://spdx.org'>SPDX Group</ulink> is a working group of
228 the Linux Foundation that maintains a specification for a standard
229 format for communicating the components, licenses, and copyrights
230 associated with a software package.
231 <ulink url='http://opensource.org'>OSI</ulink> is a corporation
232 dedicated to the Open Source Definition and the effort for reviewing
233 and approving licenses that conform to the Open Source Definition
234 (OSD).
235 </para>
236
237 <para>
238 You can find a list of the combined SPDX and OSI licenses that the
239 Yocto Project uses in the
240 <filename>meta/files/common-licenses</filename> directory in your
241 <link linkend='source-directory'>Source Directory</link>.
242 </para>
243
244 <para>
245 For information that can help you maintain compliance with various
246 open source licensing during the lifecycle of a product created using
247 the Yocto Project, see the
248 "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>"
249 section.
250 </para>
251</section>
252
169<section id="development-concepts"> 253<section id="development-concepts">
170 <title>Development Concepts</title> 254 <title>Development Concepts</title>
171 255