mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-01 00:59:48 +00:00
Code Issues Projects Releases Wiki Activity

Documentation: Updated Manual Notes

Browse Source 
I did some re-wording to account for when the user does a web
search for a manual and the search returns an ancient version
of the manual.  Many times the user is oblivious of this fact
and is trying to use a version of the docs that don't come close
to matching the version of the YP.

(From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-03-28 09:17:48 -07:00
committed by Richard Purdie
parent c1155478ba
commit 01d53451fb
12 changed files with 337 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
+29 -11
View File
@@ -20,20 +20,38 @@
<note><title>Manual Notes</title> <note><title>Manual Notes</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
For the latest version of this document associated with This version of the document is for the
this Yocto Project release &YOCTO_DOC_VERSION; release of the Yocto Project.
(version &YOCTO_DOC_VERSION;), see the "My First To be sure you have the latest version of this document
Yocto Project Build" from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
This paper is written for the &YOCTO_DOC_VERSION;. If you located this manual through a web search, the
For later releases of the Yocto Project (if they exist), version of the manual might not be the one you want
go to the (e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the Yocto Project version for which you want "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
the manual. pull-down menus.
</para></listitem>
<listitem><para>
To report any inaccuracies or problems with this
manual, send an email to the Yocto Project
discussion group at
<filename>yocto@yoctoproject.com</filename> or log into
the freenode <filename>#yocto</filename> channel.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
</note> </note>
documentation/bsp-guide/bsp-guide.xml
+19 -7
View File
@@ -141,16 +141,28 @@
is for the &YOCTO_DOC_VERSION; release of the is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this
documentation/concepts-manual/concepts-manual.xml
+19 -7
View File
@@ -58,16 +58,28 @@
is for the &YOCTO_DOC_VERSION; release of the is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this
documentation/dev-manual/dev-manual.xml
+19 -7
View File
@@ -128,16 +128,28 @@
is for the &YOCTO_DOC_VERSION; release of the is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this
documentation/getting-started/getting-started.xml
+21 -9
View File
@@ -54,20 +54,32 @@
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
This version of the This version of the
<emphasis>Getting Started With Yocto Project Manual</emphasis> <emphasis>Getting Started With Yocto Project</emphasis>
is for the &YOCTO_DOC_VERSION; release of the manual is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this
documentation/kernel-dev/kernel-dev.xml
+19 -7
View File
@@ -111,16 +111,28 @@
is for the &YOCTO_DOC_VERSION; release of the is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this
documentation/mega-manual/mega-manual.xml
+19 -7
View File
@@ -95,16 +95,28 @@
is for the &YOCTO_DOC_VERSION; release of the is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this
documentation/profile-manual/profile-manual.xml
+19 -7
View File
@@ -113,16 +113,28 @@
is for the &YOCTO_DOC_VERSION; release of the is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this
documentation/ref-manual/ref-manual.xml
+19 -7
View File
@@ -142,16 +142,28 @@
is for the &YOCTO_DOC_VERSION; release of the is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this
documentation/sdk-manual/sdk-manual.xml
+19 -8
View File
@@ -76,16 +76,28 @@
manual is for the &YOCTO_DOC_VERSION; release of the manual is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this
@@ -96,7 +108,6 @@
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
</note> </note>
</legalnotice> </legalnotice>
</bookinfo> </bookinfo>
documentation/toaster-manual/toaster-manual.xml
+19 -7
View File
@@ -86,16 +86,28 @@
is for the &YOCTO_DOC_VERSION; release of the is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this
documentation/yocto-project-qs/yocto-project-qs.xml
+19 -7
View File
@@ -143,16 +143,28 @@
is for the &YOCTO_DOC_VERSION; release of the is for the &YOCTO_DOC_VERSION; release of the
Yocto Project. Yocto Project.
To be sure you have the latest version of the manual To be sure you have the latest version of the manual
for this release, use the manual from the for this release, go to the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For manuals associated with other releases of the Yocto If you located this manual through a web search, the
Project, go to the version of the manual might not be the one you want
(e.g. the search might have returned a manual much
older than the Yocto Project version with which you
are working).
You can see all Yocto Project major releases by
visiting the
<ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
page.
If you need a version of this manual for a different
Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and use the drop-down "Active Releases" button and select the manual set by using the
and choose the manual associated with the desired "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
Yocto Project. pull-down menus.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
To report any inaccuracies or problems with this To report any inaccuracies or problems with this