summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-03-01 07:44:04 -0600
committerSaul Wold <sgw@linux.intel.com>2011-03-01 16:36:43 -0800
commitd3ae37234cf0df758e97c6690fb8de9ef2eb3f9c (patch)
tree768d390fd42a54b306f8faee0bb1737c4fff1c40 /documentation
parentf3c6ccd13cfc2a6e4bc84f602ccf44d57a59a82d (diff)
downloadpoky-d3ae37234cf0df758e97c6690fb8de9ef2eb3f9c.tar.gz
[BUGID# 553] - documentation/bsp-guide/bsp.xml: Re-write of click-through
[BUGID# 553] - In the 'BSP Click-Through Licensing Procedure' section, which is shared between the BSP Guide and the Poky Reference Manual, there were three links to 'pokylinux.org' sites. These links were intended to help a user get a license for encumbered BSPs. However, the links never did work. The section also had some wording that described a propsed naming convention for BSP tarballs that were encumbered and non-encumbered. The naming convention is a good idea but has not been followed so far. I removed the links and replaced them with general instructions on how to get through the licensing situation. Also removed the hard-line naming rules and replaces with a more general explanation of how we are naming BSP (e.g. Crown Bay). Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/bsp-guide/bsp.xml59
1 files changed, 34 insertions, 25 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 076c08cf60..ea9b0017f3 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -533,19 +533,22 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
533 </para> 533 </para>
534 534
535 <para> 535 <para>
536 For cases where you can substitute something and still maintain functionality, the Poky website will make 536 For cases where you can substitute something and still maintain functionality,
537 available a 'de-featured' BSP completely free of the encumbered IP. 537 the Yocto Project website at
538 In that case you can use the substitution directly and without any further licensing requirements. 538 <ulink url='http://yoctoproject.org/download/board-support-package-bsp-downloads'></ulink>
539 If present, this fully 'de-featured' BSP will be named meta-&lt;bsp_name&gt; (i.e. the 539 will make available a 'de-featured' BSP completely free of the encumbered IP.
540 normal default naming convention). 540 In that case you can use the substitution directly and without any further licensing
541 If available, this is the simplest the most preferred option. 541 requirements.
542 If present, this fully 'de-featured' BSP will be named appropiately different
543 than the normal encumbered BSP.
544 If available, this substitution is the simplest and most preferred option.
542 This, of course, assumes the resulting functionality meets requirements. 545 This, of course, assumes the resulting functionality meets requirements.
543 </para> 546 </para>
544 547
545 <para> 548 <para>
546 If however, a non-encumbered version is unavailable or the 'free' version would provide unsuitable 549 If however, a non-encumbered version is unavailable or the 'free' version
547 functionality or quality, an encumbered version can be used. 550 would provide unsuitable functionality or quality, you can use
548 Encumbered versions of a BSP are given names of the form meta-&lt;bsp_name&gt;-nonfree. 551 an encumbered version.
549 </para> 552 </para>
550 553
551 <para> 554 <para>
@@ -559,14 +562,23 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
559 562
560 <para> 563 <para>
561 Get a license key (or keys) for the encumbered BSP by visiting 564 Get a license key (or keys) for the encumbered BSP by visiting
565 a website and providing the name of the BSB and your email address
566 through a web form.
567 </para>
568
569<!--
562 <ulink url='https://pokylinux.org/bsp-keys.html'>https://pokylinux.org/bsp-keys.html</ulink> 570 <ulink url='https://pokylinux.org/bsp-keys.html'>https://pokylinux.org/bsp-keys.html</ulink>
563 and give the name of the BSP and your e-mail address in the web form. 571 and give the name of the BSP and your e-mail address in the web form.
564 </para> 572 </para>
565 573
574 COMMENT: This link is not implemented at this point.
575
566 <programlisting> 576 <programlisting>
567 [screenshot of dialog box] 577 [screenshot of dialog box]
568 </programlisting> 578 </programlisting>
569 579
580-->
581
570 <para> 582 <para>
571 After agreeing to any applicable license terms, the 583 After agreeing to any applicable license terms, the
572 BSP key(s) will be immediately sent to the address 584 BSP key(s) will be immediately sent to the address
@@ -609,7 +621,8 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
609 encumbered BSP. 621 encumbered BSP.
610 These prompts usually take the form of instructions 622 These prompts usually take the form of instructions
611 needed to manually fetch the encumbered package(s) 623 needed to manually fetch the encumbered package(s)
612 and md5 sums into the required directory (e.g. the poky/build/downloads) 624 and md5 sums into the required directory
625 (e.g. the <filename>poky/build/downloads</filename>).
613 Once the manual package fetch has been 626 Once the manual package fetch has been
614 completed, restart the build to continue where 627 completed, restart the build to continue where
615 it left off. 628 it left off.
@@ -619,25 +632,21 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
619 </listitem> 632 </listitem>
620 <listitem> 633 <listitem>
621 <para> 634 <para>
622 Get a full-featured BSP recipe rather than a key, by 635 Get a full-featured BSP recipe rather than a key.
623 visiting 636 You can do this by visiting the applicable BSP download page from the Yocto
624 <ulink url='https://pokylinux.org/bsps.html'>https://pokylinux.org/bsps.html</ulink>. 637 Project website at
625 Accepting the license agreement(s) presented will 638 <ulink url='http://yoctoproject.org/download/board-support-package-bsp-downloads'></ulink>.
626 subsequently allow you to download a tarball 639 BSP tarballs that have proprietary information can be downloaded after agreeing
627 containing a full-featured BSP that is legally cleared for 640 to licensing requirements as part of the download process.
628 your use by the just-given license agreement(s). 641 Obtaining the code this way allows you to build an encumbered image with
629 This method will also allow the encumbered image to 642 no changes at all as compared to the normal build.
630 be built with no change at all to the normal build 643 </para>
631 process.
632 </para>
633 </listitem> 644 </listitem>
634 </orderedlist> 645 </orderedlist>
635 <para> 646 <para>
636 Note that the third method is also the only option available 647 Note that the third method is also the only option available
637 when downloading pre-compiled images generated from 648 when downloading pre-compiled images generated from non-free BSPs.
638 non-free BSPs. 649 Those images are likewise available at from the Yocto Project website.
639 Those images are likewise available at
640 <ulink url='https://pokylinux.org/bsps.html'>https://pokylinux.org/bsps.html</ulink>.
641 </para> 650 </para>
642 </section> 651 </section>
643 652