documentation: Updated Manual Notes

Updated the notes on the title page to give the user some
advice for when he searches for the manual and gets old
manuals.

(From yocto-docs rev: 7dedbb67272a18bd768ab5fe637b20a09801d904)

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 12:26:45 -07:00 committed by Richard Purdie
parent 9b7bc41dfa
commit 24344d5504
9 changed files with 321 additions and 201 deletions

View File

@ -150,34 +150,46 @@
Permission is granted to copy, distribute and/or modify this document under Permission is granted to copy, distribute and/or modify this document under
the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-nc-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons. the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-nc-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
</para> </para>
<note><title>Manual Notes</title> <note><title>Manual Notes</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
For the latest version of the Yocto Project Board This version of the
Support Package (BSP) Developer's Guide associated with <emphasis>Yocto Project Board Support Package (BSP) Developer's Guide</emphasis>
this Yocto Project release (version is for the &YOCTO_DOC_VERSION; release of the
&YOCTO_DOC_VERSION;), Yocto Project.
see the Yocto Project Board Support Package (BSP) To be sure you have the latest version of the manual
Developer's Guide 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>
</para></listitem> and select the manual from that site.
<listitem><para> Manuals from the site are more up-to-date than manuals
This version of the manual is version derived from the Yocto Project released TAR files.
&YOCTO_DOC_VERSION;. </para></listitem>
For later releases of the Yocto Project (if they exist), <listitem><para>
go to the If you located this manual through a web search, the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> version of the manual might not be the one you want
and use the drop-down "Active Releases" button (e.g. the search might have returned a manual much
and choose the Yocto Project version for which you want older than the Yocto Project version with which you
the manual. are working).
</para></listitem> You can see all Yocto Project major releases by
<listitem><para> visiting the
For an in-development version of the Yocto Project <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
Board Support Package (BSP) Developer's Guide, see page.
<ulink url='&YOCTO_DOCS_URL;/latest/bsp-guide/bsp-guide.html'></ulink>. If you need a version of this manual for a different
</para></listitem> Yocto Project release, visit the
</itemizedlist> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
</note> and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
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>
</itemizedlist>
</note>
</legalnotice> </legalnotice>
</bookinfo> </bookinfo>

View File

@ -131,32 +131,46 @@
Creative Commons. Creative Commons.
</para> </para>
<note><title>Manual Notes</title> <note><title>Manual Notes</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
For the latest version of the Yocto Project Development This version of the
Manual associated with this Yocto Project release <emphasis>Yocto Project Development Manual</emphasis>
(version &YOCTO_DOC_VERSION;), is for the &YOCTO_DOC_VERSION; release of the
see the Yocto Project Development Manual from the Yocto Project.
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. To be sure you have the latest version of the manual
</para></listitem> for this release, go to the
<listitem><para> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
This version of the manual is version and select the manual from that site.
&YOCTO_DOC_VERSION;. Manuals from the site are more up-to-date than manuals
For later releases of the Yocto Project (if they exist), derived from the Yocto Project released TAR files.
go to the </para></listitem>
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <listitem><para>
and use the drop-down "Active Releases" button If you located this manual through a web search, the
and choose the Yocto Project version for which you want version of the manual might not be the one you want
the manual. (e.g. the search might have returned a manual much
</para></listitem> older than the Yocto Project version with which you
<listitem><para> are working).
For an in-development version of the Yocto Project You can see all Yocto Project major releases by
Development Manual, see visiting the
<ulink url='&YOCTO_DOCS_URL;/latest/dev-manual/dev-manual.html'></ulink>. <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
</para></listitem> page.
</itemizedlist> If you need a version of this manual for a different
</note> Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
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>
</itemizedlist>
</note>
</legalnotice> </legalnotice>
</bookinfo> </bookinfo>

View File

@ -116,30 +116,43 @@
<note><title>Manual Notes</title> <note><title>Manual Notes</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
For the latest version of the Yocto Project Linux This version of the
Kernel Development Manual associated with this Yocto <emphasis>Yocto Project Linux Kernel Development Manual</emphasis>
Project release (version &YOCTO_DOC_VERSION;), is for the &YOCTO_DOC_VERSION; release of the
see the Yocto Project Linux Kernel Development Yocto Project.
Manual from the To be sure you have the latest version of the manual
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. for this release, go to the
</para></listitem>
<listitem><para>
This version of the manual is version
&YOCTO_DOC_VERSION;.
For later releases of the Yocto Project (if they exist),
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 use the drop-down "Active Releases" button and select the manual from that site.
and choose the Yocto Project version for which you want Manuals from the site are more up-to-date than manuals
the manual. derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For an in-development version of the Yocto Project If you located this manual through a web search, the
Linux Kernel Development Manual, see version of the manual might not be the one you want
<ulink url='&YOCTO_DOCS_URL;/latest/kernel-dev/kernel-dev.html'></ulink>. (e.g. the search might have returned a manual much
</para></listitem> older than the Yocto Project version with which you
</itemizedlist> are working).
</note> 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>
and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
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>
</itemizedlist>
</note>
</legalnotice> </legalnotice>
</bookinfo> </bookinfo>

View File

@ -100,26 +100,40 @@
<note><title>Manual Notes</title> <note><title>Manual Notes</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
For the latest version of the Yocto Project This version of the
Mega-Manual associated with this Yocto Project release <emphasis>Yocto Project Mega-Manual</emphasis>
(version &YOCTO_DOC_VERSION;), is for the &YOCTO_DOC_VERSION; release of the
see the Yocto Project Mega-Manual from the Yocto Project.
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. To be sure you have the latest version of the manual
</para></listitem> for this release, go to the
<listitem><para>
This version of the manual is version
&YOCTO_DOC_VERSION;.
For later releases of the Yocto Project (if they exist),
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 use the drop-down "Active Releases" button and select the manual from that site.
and choose the Yocto Project version for which you want Manuals from the site are more up-to-date than manuals
the manual. derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For an in-development version of the Yocto Project If you located this manual through a web search, the
Mega-Manual, see version of the manual might not be the one you want
<ulink url='&YOCTO_DOCS_URL;/latest/mega-manual/mega-manual.html'></ulink>. (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>
and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
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>

View File

@ -116,33 +116,46 @@
Creative Commons. Creative Commons.
</para> </para>
<note><title>Manual Notes</title> <note><title>Manual Notes</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
For the latest version of the Yocto Project Profiling This version of the
and Tracing Manual associated with this Yocto Project <emphasis>Yocto Project Profiling and Tracing Manual</emphasis>
release (version &YOCTO_DOC_VERSION;), is for the &YOCTO_DOC_VERSION; release of the
see the Yocto Project Profiling and Tracing Manual Yocto Project.
from the To be sure you have the latest version of the manual
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. for this release, go to the
</para></listitem> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
<listitem><para> and select the manual from that site.
This version of the manual is version Manuals from the site are more up-to-date than manuals
&YOCTO_DOC_VERSION;. derived from the Yocto Project released TAR files.
For later releases of the Yocto Project (if they exist), </para></listitem>
go to the <listitem><para>
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> If you located this manual through a web search, the
and use the drop-down "Active Releases" button version of the manual might not be the one you want
and choose the Yocto Project version for which you want (e.g. the search might have returned a manual much
the manual. older than the Yocto Project version with which you
</para></listitem> are working).
<listitem><para> You can see all Yocto Project major releases by
For an in-development version of the Yocto Project visiting the
Profiling and Tracing Manual, see <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
<ulink url='&YOCTO_DOCS_URL;/latest/profile-manual/profile-manual.html'></ulink>. page.
</para></listitem> If you need a version of this manual for a different
</itemizedlist> Yocto Project release, visit the
</note> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
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>
</itemizedlist>
</note>
</legalnotice> </legalnotice>
</bookinfo> </bookinfo>

View File

@ -147,29 +147,43 @@
<note><title>Manual Notes</title> <note><title>Manual Notes</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
For the latest version of the Yocto Project Reference This version of the
Manual associated with this Yocto Project release <emphasis>Yocto Project Reference Manual</emphasis>
(version &YOCTO_DOC_VERSION;), is for the &YOCTO_DOC_VERSION; release of the
see the Yocto Project Reference Manual from the Yocto Project.
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. To be sure you have the latest version of the manual
</para></listitem> for this release, go to the
<listitem><para>
This version of the manual is version
&YOCTO_DOC_VERSION;.
For later releases of the Yocto Project (if they exist),
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 use the drop-down "Active Releases" button and select the manual from that site.
and choose the Yocto Project version for which you want Manuals from the site are more up-to-date than manuals
the manual. derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For an in-development version of the Yocto Project If you located this manual through a web search, the
Reference Manual, see version of the manual might not be the one you want
<ulink url='&YOCTO_DOCS_URL;/latest/ref-manual/ref-manual.html'></ulink>. (e.g. the search might have returned a manual much
</para></listitem> older than the Yocto Project version with which you
</itemizedlist> are working).
</note> 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>
and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
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>
</itemizedlist>
</note>
</legalnotice> </legalnotice>
</bookinfo> </bookinfo>

View File

@ -81,27 +81,40 @@
<note><title>Manual Notes</title> <note><title>Manual Notes</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
For the latest version of the Yocto Project Software This version of the
Development Kit (SDK) Developer's Guide associated with <emphasis>Yocto Project Software Development Kit (SDK) Developer's Guide</emphasis>
this Yocto Project release (version &YOCTO_DOC_VERSION;), is for the &YOCTO_DOC_VERSION; release of the
see the Yocto Project Software Development Kit (SDK) Yocto Project.
Developer's Guide from the To be sure you have the latest version of the manual
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. for this release, go to the
</para></listitem>
<listitem><para>
This version of the manual is version
&YOCTO_DOC_VERSION;.
For later releases of the Yocto Project (if they exist),
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 use the drop-down "Active Releases" button and select the manual from that site.
and choose the Yocto Project version for which you want Manuals from the site are more up-to-date than manuals
the manual. derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For an in-development version of the Yocto Project If you located this manual through a web search, the
Software Development Kit (SDK) Developer's Guide, see version of the manual might not be the one you want
<ulink url='&YOCTO_DOCS_URL;/latest/sdk-manual/sdk-manual.html'></ulink>. (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>
and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
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>

View File

@ -91,26 +91,40 @@
<note><title>Manual Notes</title> <note><title>Manual Notes</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
For the latest version of the Yocto Project Toaster This version of the
User Manual associated with this Yocto Project release <emphasis>Toaster User Manual</emphasis>
(version &YOCTO_DOC_VERSION;), is for the &YOCTO_DOC_VERSION; release of the
see the Yocto Project Toaster User Manual from the Yocto Project.
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. To be sure you have the latest version of the manual
</para></listitem> for this release, go to the
<listitem><para>
This version of the manual is version
&YOCTO_DOC_VERSION;.
For later releases of the Yocto Project (if they exist),
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 use the drop-down "Active Releases" button and select the manual from that site.
and choose the Yocto Project version for which you want Manuals from the site are more up-to-date than manuals
the manual. derived from the Yocto Project released TAR files.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
For an in-development version of the Yocto Project If you located this manual through a web search, the
Toaster User Manual, see version of the manual might not be the one you want
<ulink url='&YOCTO_DOCS_URL;/latest/toaster-manual/toaster-manual.html'></ulink>. (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>
and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
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>

View File

@ -16,35 +16,48 @@
Permission is granted to copy, distribute and/or modify this document under Permission is granted to copy, distribute and/or modify this document under
the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons. the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
</para> </para>
<note><title>Manual Notes</title> <note><title>Manual Notes</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
For the latest version of the Yocto Project Quick This version of the
Start associated with this Yocto Project release <emphasis>Yocto Project Quick Start</emphasis>
(version &YOCTO_DOC_VERSION;), is for the &YOCTO_DOC_VERSION; release of the
see the Yocto Project Quick Start from the Yocto Project.
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. To be sure you have the latest version of the manual
</para></listitem> for this release, go to the
<listitem><para> <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
This version of the manual is version and select the manual from that site.
&YOCTO_DOC_VERSION;. Manuals from the site are more up-to-date than manuals
For later releases of the Yocto Project (if they exist), derived from the Yocto Project released TAR files.
go to the </para></listitem>
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> <listitem><para>
and use the drop-down "Active Releases" button If you located this manual through a web search, the
and choose the Yocto Project version for which you want version of the manual might not be the one you want
the manual. (e.g. the search might have returned a manual much
</para></listitem> older than the Yocto Project version with which you
<listitem><para> are working).
For an in-development version of the Yocto Project You can see all Yocto Project major releases by
Quick Start, see visiting the
<ulink url='&YOCTO_DOCS_URL;/latest/yocto-project-qs/yocto-project-qs.html'></ulink>. <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
</para></listitem> page.
</itemizedlist> If you need a version of this manual for a different
</note> Yocto Project release, visit the
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
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>
</itemizedlist>
</note>
</legalnotice> </legalnotice>
<abstract> <abstract>
<imagedata fileref="figures/yocto-project-transp.png" <imagedata fileref="figures/yocto-project-transp.png"
width="6in" depth="1in" width="6in" depth="1in"