Poky Reference Manual and BSP Manual Updates
PATCH 2/12 documentation/poky-ref-manual/introduction.xml: [BUGID# 553] - Fixed pokylinux.org link in Nightly Build section
In reply to [email protected]From: Scott Rifenbark <[email protected]>
[BUGID# 553] - In the nightly build section (1.5.2) there is a reference to
http://autobuilder.pokylinux.org/. This URL resolves to an autobuilder page that has a bunch of pokylinux links. I determined that the URL
http://autobuilder.yoctoproject.org/ also resolves to the autobuilder page so I updated the URL to use the YP link. This is a partial fix to Bug 553.
--- documentation/poky-ref-manual/introduction.xml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/poky-ref-manual/introduction.xml +1 -1
@@ -129,7 +129,7 @@ <para> We make nightly builds of Poky for testing purposes and to make the latest developments available. The output from these builds is available - at <ulink url='http://autobuilder.pokylinux.org/'/>. + at <ulink url='http://autobuilder.yoctoproject.org/'/>. The numbers used in the builds increase for each subsequent build and can be used to reference a specific build. </para>
Signature · 1 line
1.7.1
PATCH 3/12 documentation/poky-ref-manual/introduction.xml: [BUGID# 553] - Fixed pokylinux URL
In reply to [email protected]From: Scott Rifenbark <[email protected]>
[BUGID# 553] - In the Development Checkouts section (1.5.3) there is a reference to
http://git.pokylinux.org/. This URL resolves to an older looking source area. I determined that the URL
http://git.yoctoproject.org/ resolves to the newer Yocto source web interface so I changed the URL to that.
This is a partial fix
to Bug 553.
--- documentation/poky-ref-manual/introduction.xml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/poky-ref-manual/introduction.xml +1 -1
@@ -153,7 +153,7 @@ <para> Poky is available from our git repository located at git://git.pokylinux.org/poky.git; a web interface to the repository - can be accessed at <ulink url='http://git.pokylinux.org/'/>. + can be accessed at <ulink url='http://git.yoctoproject.org/'/>. </para> <para>
Signature · 1 line
1.7.1
cover Poky Reference Manual and BSP Manual Updates
From: Scott Rifenbark <[email protected]>
The bulk of these changes closes out BUG #553. This addresses the 'pokylinux.org' links that were scattered throughout the Poky Reference Manual and also in the BSP Guide (Click-through Licensing section). All of these URLs have been addressed. Bug #533 can be closed once these changes are merged.
Also fixed in this set is an issue that was found during Alpha testing regarding the documentation of supported images. The "Images" appendix in the Poky Reference Manual was updated to instruct the user to use a modified 'ls' command (ls meta*/recipes*/images/*.bb) to discover the supported .bb files in the build directory.
Finally, another small fix in the Resources Appendix in the Poky Reference Manaul. There was a bulleted list with entries. Two of the entries had no supporting text. I added simple text for consistency.
Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: srifenbark/docs
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=srifenbark/docs
Thanks,
<[email protected]>
---
Scott Rifenbark (12):
documentation/poky-ref-manual/ref-images.xml: Update to Images
Appendix
documentation/poky-ref-manual/introduction.xml: [BUGID# 553] - Fixed
pokylinux.org link in Nightly Build section
documentation/poky-ref-manual/introduction.xml: [BUGID# 553] - Fixed
pokylinux URL
[BUGID# 553] - documentation/poky-ref-manual/introduction.xml: Fixed
pokylinux.org URL
[BUGID# 553] - documentation/poky-ref-manual/introduction.xml: fixed
pokylinux.org URL
[BUGID# 553] - documentation/poky-ref-manual/development.xml: Fixed
pokylinux URLs
[BUGID# 553] - documentation/poky-ref-manual/development.xml: Fixed
pokylinux.org URL
[BUGID# 553] - documentation/poky-ref-manual/faq.xml: Fixed
pokylinux.org reference
[BUGID# 553] - documentation/poky-ref-manual/resources.xml: Fixed
pokylinux URL
documentation/poky-ref-manual/resources.xml: Text addtions in Links
section in Appendix I
[BUGID# 553] - documentation/poky-ref-manual/resources.xml: Fixed
pokylinux URL
[BUGID# 553] - documentation/bsp-guide/bsp.xml: Re-write of
click-through
documentation/bsp-guide/bsp.xml | 59 ++++++++++++++---------- documentation/poky-ref-manual/development.xml | 12 ++-- documentation/poky-ref-manual/faq.xml | 3 +- documentation/poky-ref-manual/introduction.xml | 8 ++-- documentation/poky-ref-manual/ref-images.xml | 59 ++++++++++++++---------- documentation/poky-ref-manual/resources.xml | 13 +++-- 6 files changed, 87 insertions(+), 67 deletions(-)
PATCH 1/12 documentation/poky-ref-manual/ref-images.xml: Update to Images Appendix
From: Scott Rifenbark <[email protected]>
Added command 'ls meta*/recipes*/images/*.bb' as the command to see the supported images. Also added poky-image-lsb as an image and noted that poky-image-sdk has becom poky-image-sato-dev.
These fixes are in response to alpha testing for release 1.0 Yocto.
--- documentation/poky-ref-manual/ref-images.xml | 59 +++++++++++++++----------- 1 files changed, 34 insertions(+), 25 deletions(-)
documentation/poky-ref-manual/ref-images.xml +34 -25
@@ -5,62 +5,71 @@ <title>Reference: Images</title> <para> - Poky has several standard images covering most people's standard needs. A full - list of image targets can be found by looking in the directories - <filename class="directory"> meta/recipes-core/images/</filename>, - <filename class="directory"> meta/recipes-extended/images/</filename>, - <filename class="directory"> meta/recipes-sato/images/</filename> and - <filename class="directory"> meta/recipes-tbd/meta/</filename>. The standard - images are listed below along with details of what they contain: + Poky has several standard images covering most people's standard needs. + Use the following command to list the supported images: + <literallayout class='monospaced'> + $ ls meta*/recipes*/images/*.bb + </literallayout> + Images are listed below along with details of what they contain: </para> <itemizedlist> <listitem> <para> - <emphasis>poky-image-minimal</emphasis> - A small image, just enough - to allow a device to boot + <emphasis>poky-image-minimal</emphasis> - A small image just capable + of allowing a device to boot. </para> </listitem> <listitem> <para> - <emphasis>poky-image-base</emphasis> - console only image with full - support of target device hardware + <emphasis>poky-image-base</emphasis> - A console-only image that fully + supports the target device hardware. </para> </listitem> <listitem> <para> - <emphasis>poky-image-core</emphasis> - X11 image with simple apps like - terminal, editor and file manager + <emphasis>poky-image-core</emphasis> - An X11 image with simple + applications such as terminal, editor, and file manager. </para> </listitem> <listitem> <para> - <emphasis>poky-image-sato</emphasis> - X11 image with Sato theme and - Pimlico applications. Also contains terminal, editor and file manager. + <emphasis>poky-image-sato</emphasis> - An X11 image with Sato theme and + Pimlico applications. + The image also contains terminal, editor, and file manager. </para> </listitem> <listitem> <para> - <emphasis>poky-image-sdk</emphasis> - X11 image like poky-image-sato but - also include native toolchain and libraries needed to build applications - on the device itself. Also includes testing and profiling tools and debug - symbols. + <emphasis>poky-image-sato-dev</emphasis> - An X11 image similar to + poky-image-sato but + also includes a native toolchain and libraries needed to build applications + on the device itself. The image also includes testing and profiling tools + as well as debug symbols. This image was formerly poky-image-sdk. </para> </listitem> <listitem> <para> - <emphasis>meta-toolchain</emphasis> - This generates a tarball containing - a standalone toolchain which can be used externally to Poky. It is self - contained and unpacks to the <filename class="directory">/opt/poky</filename> - directory. It also contains a copy of QEMU and the scripts necessary to run + <emphasis>poky-image-lsb</emphasis> - An image suitable for implementations + that conform to Linux Standard Base (LSB). + </para> + </listitem> + <listitem> + <para> + <emphasis>meta-toolchain</emphasis> - This image generates a tarball + that contains a stand-alone toolchain that can be used externally to Poky. + The tarball is self-contained and unpacks to the + <filename class="directory">/opt/poky</filename> directory. + The tarball also contains a copy of QEMU and the scripts necessary to run poky QEMU images. </para> </listitem> <listitem> <para> - <emphasis>meta-toolchain-sdk</emphasis> - This includes everything in + <emphasis>meta-toolchain-sdk</emphasis> - This image includes everything in meta-toolchain but also includes development headers and libraries - forming a complete standalone SDK. See the <link linkend='platdev-appdev-external-sdk'> + to form a complete standalone SDK. + See the <link linkend='platdev-appdev-external-sdk'> External Development Using the Poky SDK</link> section for more information. </para> </listitem>
Signature · 1 line
1.7.1
PATCH 4/12 - documentation/poky-ref-manual/introduction.xml: Fixed pokylinux.org URL
In reply to [email protected]From: Scott Rifenbark <[email protected]>
[BUGID# 553] - In the Releases section (1.5.1) there was an URL to
http://pokylinux.org/releases. This URL was old and I replaced it with http://yoctoproject.org/downloads/poky. This partially fixes bug 553.
--- documentation/poky-ref-manual/introduction.xml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/poky-ref-manual/introduction.xml +1 -1
@@ -118,7 +118,7 @@ <title>Releases</title> <para>Periodically, we make releases of Poky available - at <ulink url='http://pokylinux.org/releases/'/>. + at <ulink url='http://yoctoproject.org/downloads/poky/'/>. These releases are more stable and more rigorously tested than the nightly development images. </para> </section>
Signature · 1 line
1.7.1
PATCH 5/12 - documentation/poky-ref-manual/introduction.xml: fixed pokylinux.org URL
In reply to [email protected]From: Scott Rifenbark <[email protected]>
[BUGID# 553] - In the Development Checkouts section (1.5.3) there was a reference to our git repository located at git://git.pokylinux.org/poky.git.
I changed this to git://git.yoctoproject.org/poky.git. This is a partial fix to Bug 553.
--- documentation/poky-ref-manual/introduction.xml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/poky-ref-manual/introduction.xml +1 -1
@@ -152,7 +152,7 @@ <para> Poky is available from our git repository located at - git://git.pokylinux.org/poky.git; a web interface to the repository + git://git.yoctoproject.org/poky.git; a web interface to the repository can be accessed at <ulink url='http://git.yoctoproject.org/'/>. </para>
Signature · 1 line
1.7.1
PATCH 6/12 - documentation/poky-ref-manual/development.xml: Fixed pokylinux URLs
In reply to [email protected]From: Scott Rifenbark <[email protected]>
[BUGID# 553] - In "The Eclipse Plug-in" section (5.1.2.1) there were two URLs referencing the place to get the Eclipse plug-in. One specified the URL to put into the HTTP:// field in the Eclipse IDE when installing the software. This URL was incorrect. I replaced it with the correct URL, which was http://www.yoctoproject.org/downloads/eclipse-plugin/.
The second URL that was fixed was referencing the source code for the plug-in. It had the old pokylinux.org string. I changed it to
http://git.yoctoproject.org.
These fixes partially address bug 553.
--- documentation/poky-ref-manual/development.xml | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-)
documentation/poky-ref-manual/development.xml +3 -2
@@ -67,12 +67,13 @@ <literallayout class='monospaced'> Help -> Install New Software </literallayout> - Specify the target URL as <ulink url='http://www.yoctoproject.org/downloads/eclipse-plug-in/'></ulink>. + Specify the target URL as + <ulink url='http://www.yoctoproject.org/downloads/eclipse-plugin/'></ulink>. </para> <para> If you want to download the source code for the plug-in you can find it in the Poky git repository, which has a web interface, and is located at - <ulink url="http://git.pokylinux.org/cgit.cgi/eclipse-poky"></ulink>. + <ulink url="http://git.yoctoproject.org"></ulink> under IDE Plugins. </para> <section id="installing-and-setting-up-the-eclipse-ide">
Signature · 1 line
1.7.1
PATCH 7/12 - documentation/poky-ref-manual/development.xml: Fixed pokylinux.org URL
In reply to [email protected]From: Scott Rifenbark <[email protected]>
[BUGID# 553] - In "The Anjuta Plug-in" section (5.1.2.2) there was an URL to the source for the Anjuta Plug-in. The URL had the pokylinux.org string in it and pointed to the old area. I changed the URL to http://git.yoctoproject.org and directed the user to look under IDE Plugins.
This is a partial fix to bug 553.
--- documentation/poky-ref-manual/development.xml | 7 +++---- 1 files changed, 3 insertions(+), 4 deletions(-)
documentation/poky-ref-manual/development.xml +3 -4
@@ -302,10 +302,9 @@ Plug-in are all required. The Poky Anjuta Plug-in is available to download as a tarball at the OpenedHand labs <ulink url="http://labs.o-hand.com/anjuta-poky-sdk-plugin/"></ulink> page or - directly from the Poky Git repository located at - <ulink url="git://git.pokylinux.org/anjuta-poky"></ulink>. - You can also access a web interface to the repository at - <ulink url="http://git.pokylinux.org/?p=anjuta-poky.git;a=summary"></ulink>. + directly from the Poky Git repository located at git://git.yoctoproject.org/anjuta-poky. + You can access the source code from a web interface to the repository at + <ulink url="http://git.yoctoproject.org/"></ulink> under IDE Plugins. </para> <para> See the README file contained in the project for more information on
Signature · 1 line
1.7.1
PATCH 8/12 - documentation/poky-ref-manual/faq.xml: Fixed pokylinux.org reference
In reply to [email protected]From: Scott Rifenbark <[email protected]>
[BUGID# 553] - In the FAQ appendix item H.12 there was a reference to http://pokylinux.org/sources/* in the question portion. The reference should really be http://autobuilder.yoctoproject.org/sources/*.
I made the change.
This is a partial fix for bug 553.
--- documentation/poky-ref-manual/faq.xml | 3 ++- 1 files changed, 2 insertions(+), 1 deletions(-)
documentation/poky-ref-manual/faq.xml +2 -1
@@ -248,7 +248,8 @@ <qandaentry> <question> <para> - I see lots of 404 responses for files on http://pokylinux.org/sources/*. Is something wrong? + I see lots of 404 responses for files on + http://autobuilder.yoctoproject.org/sources/*. Is something wrong? </para> </question> <answer>
Signature · 1 line
1.7.1
PATCH 9/12 - documentation/poky-ref-manual/resources.xml: Fixed pokylinux URL
In reply to [email protected]From: Scott Rifenbark <[email protected]>
[BUGID# 553] - In the "Bugtracker" section (appendix I - I.2) there is a reference to the bugtracker. The text shows just the string "bug tracker" but the hidden URL was http://bugzilla.pokylinux.org.
I updated the text to say to report problems by using the Bugzilla application and then gave the URL http://bugzilla.yoctoproject.org
as the reference.
This is a partial fix for bug 553.
--- documentation/poky-ref-manual/resources.xml | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-)
documentation/poky-ref-manual/resources.xml +2 -2
@@ -18,8 +18,8 @@ <title>Bugtracker</title> <para> - Problems with Poky should be reported in the - <ulink url='http://bugzilla.pokylinux.org/'>bug tracker</ulink>. + Problems with Poky should be reported using the Bugzilla application at + <ulink url='http://bugzilla.yoctoproject.org/'></ulink>. </para> </section>
Signature · 1 line
1.7.1
PATCH 10/12 documentation/poky-ref-manual/resources.xml: Text addtions in Links section in Appendix I
In reply to [email protected]From: Scott Rifenbark <[email protected]>
I added text after the bulleted items "The Poky website" and "BitBake Uer Manual." These were blank and it was not consistent with the rest of the list.
--- documentation/poky-ref-manual/resources.xml | 7 ++++--- 1 files changed, 4 insertions(+), 3 deletions(-)
documentation/poky-ref-manual/resources.xml +4 -3
@@ -75,7 +75,8 @@ for Yocto Project. </para></listitem> <listitem><para> - <ulink url='http://pokylinux.org'>The Poky website</ulink> + <ulink url='http://pokylinux.org'>The Poky website</ulink> - The home site + for Poky Linux. </para></listitem> <listitem><para> <ulink url='http://www.openedhand.com/'>OpenedHand</ulink> - The
@@ -96,8 +97,8 @@ - The tool used to process Poky metadata. </para></listitem> <listitem><para> - <ulink url='http://bitbake.berlios.de/manual/'>Bitbake User - Manual</ulink> + <ulink url='http://bitbake.berlios.de/manual/'>BitBake User + Manual</ulink> - A comprehensive guide to the BitBake tool. </para></listitem> <listitem><para> <ulink url='http://pimlico-project.org/'>Pimlico</ulink> - A
Signature · 1 line
1.7.1
PATCH 11/12 - documentation/poky-ref-manual/resources.xml: Fixed pokylinux URL
In reply to [email protected]From: Scott Rifenbark <[email protected]>
[BUGID# 553] - In appendix I in the Contributions section (I.6) there is mention of a Poky contributions tree and the URLgit://git.pokylinux.org/poky-contrib.git is given. I changed this URL to git://git.yoctoproject.org/poky-contrib.git.
This is a partial fix for but 553.
--- documentation/poky-ref-manual/resources.xml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/poky-ref-manual/resources.xml +1 -1
@@ -149,7 +149,7 @@ </programlisting> <para> - A Poky contributions tree (poky-contrib, git://git.pokylinux.org/poky-contrib.git) + A Poky contributions tree (poky-contrib, git://git.yoctoproject.org/poky-contrib.git) exists for people to stage contributions in, for regular contributors. If people desire such access, please ask on the mailing list. Usually access will be given to anyone with a proven track record of good patches.
Signature · 1 line
1.7.1
PATCH 12/12 - documentation/bsp-guide/bsp.xml: Re-write of click-through
In reply to [email protected]From: Scott Rifenbark <[email protected]>
[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).
--- documentation/bsp-guide/bsp.xml | 59 ++++++++++++++++++++++---------------- 1 files changed, 34 insertions(+), 25 deletions(-)
documentation/bsp-guide/bsp.xml +34 -25
@@ -533,19 +533,22 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}" </para> <para> - For cases where you can substitute something and still maintain functionality, the Poky website will make - available a 'de-featured' BSP completely free of the encumbered IP. - In that case you can use the substitution directly and without any further licensing requirements. - If present, this fully 'de-featured' BSP will be named meta-<bsp_name> (i.e. the - normal default naming convention). - If available, this is the simplest the most preferred option. + For cases where you can substitute something and still maintain functionality, + the Yocto Project website at + <ulink url='http://yoctoproject.org/download/board-support-package-bsp-downloads'></ulink> + will make available a 'de-featured' BSP completely free of the encumbered IP. + In that case you can use the substitution directly and without any further licensing + requirements. + If present, this fully 'de-featured' BSP will be named appropiately different + than the normal encumbered BSP. + If available, this substitution is the simplest and most preferred option. This, of course, assumes the resulting functionality meets requirements. </para> <para> - If however, a non-encumbered version is unavailable or the 'free' version would provide unsuitable - functionality or quality, an encumbered version can be used. - Encumbered versions of a BSP are given names of the form meta-<bsp_name>-nonfree. + If however, a non-encumbered version is unavailable or the 'free' version + would provide unsuitable functionality or quality, you can use + an encumbered version. </para> <para>
@@ -559,14 +562,23 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}" <para> Get a license key (or keys) for the encumbered BSP by visiting + a website and providing the name of the BSB and your email address + through a web form. + </para> + +<!-- <ulink url='https://pokylinux.org/bsp-keys.html'>https://pokylinux.org/bsp-keys.html</ulink> and give the name of the BSP and your e-mail address in the web form. </para> + COMMENT: This link is not implemented at this point. + <programlisting> [screenshot of dialog box] </programlisting> +--> + <para> After agreeing to any applicable license terms, the BSP key(s) will be immediately sent to the address
@@ -609,7 +621,8 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}" encumbered BSP. These prompts usually take the form of instructions needed to manually fetch the encumbered package(s) - and md5 sums into the required directory (e.g. the poky/build/downloads) + and md5 sums into the required directory + (e.g. the <filename>poky/build/downloads</filename>). Once the manual package fetch has been completed, restart the build to continue where it left off.
@@ -619,25 +632,21 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}" </listitem> <listitem> <para> - Get a full-featured BSP recipe rather than a key, by - visiting - <ulink url='https://pokylinux.org/bsps.html'>https://pokylinux.org/bsps.html</ulink>. - Accepting the license agreement(s) presented will - subsequently allow you to download a tarball - containing a full-featured BSP that is legally cleared for - your use by the just-given license agreement(s). - This method will also allow the encumbered image to - be built with no change at all to the normal build - process. - </para> + Get a full-featured BSP recipe rather than a key. + You can do this by visiting the applicable BSP download page from the Yocto + Project website at + <ulink url='http://yoctoproject.org/download/board-support-package-bsp-downloads'></ulink>. + BSP tarballs that have proprietary information can be downloaded after agreeing + to licensing requirements as part of the download process. + Obtaining the code this way allows you to build an encumbered image with + no changes at all as compared to the normal build. + </para> </listitem> </orderedlist> <para> Note that the third method is also the only option available - when downloading pre-compiled images generated from - non-free BSPs. - Those images are likewise available at - <ulink url='https://pokylinux.org/bsps.html'>https://pokylinux.org/bsps.html</ulink>. + when downloading pre-compiled images generated from non-free BSPs. + Those images are likewise available at from the Yocto Project website. </para> </section>
Signature · 1 line
1.7.1