summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-03-28 10:34:17 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-05-29 11:41:57 +0100
commitef4bb21693832d68dcdf6f78208591df029ac02b (patch)
tree49da74bd1ac14399e3a9deaa81b77f59d308a53f /documentation/ref-manual
parent9c3da34ec6c2c9a9abc30c72d6a8f9b996250862 (diff)
downloadpoky-ef4bb21693832d68dcdf6f78208591df029ac02b.tar.gz
documentation: Updated manual notes
I updated the notes to help the user get the version of the docs that they are interested in. Sometimes a search using the web returns really old versions of the manual and the user is clueless about using a manual that is not matching the YP release they are working with. (From yocto-docs rev: d0ef1c7edec0a28ce8a49992b71e6d3c878cdbb4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-manual.xml39
1 files changed, 26 insertions, 13 deletions
diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml
index d4b7bee7d5..80fd8e536e 100644
--- a/documentation/ref-manual/ref-manual.xml
+++ b/documentation/ref-manual/ref-manual.xml
@@ -139,6 +139,7 @@
139 Permission is granted to copy, distribute and/or modify this document under 139 Permission is granted to copy, distribute and/or modify this document under
140 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. 140 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.
141 </para> 141 </para>
142
142 <note><title>Manual Notes</title> 143 <note><title>Manual Notes</title>
143 <itemizedlist> 144 <itemizedlist>
144 <listitem><para> 145 <listitem><para>
@@ -147,24 +148,36 @@
147 is for the &YOCTO_DOC_VERSION; release of the 148 is for the &YOCTO_DOC_VERSION; release of the
148 Yocto Project. 149 Yocto Project.
149 To be sure you have the latest version of the manual 150 To be sure you have the latest version of the manual
150 for this release, use the manual from the 151 for this release, go to the
151 <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. 152 <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
153 and select the manual from that site.
154 Manuals from the site are more up-to-date than manuals
155 derived from the Yocto Project released TAR files.
152 </para></listitem> 156 </para></listitem>
153 <listitem><para> 157 <listitem><para>
154 For manuals associated with other releases of the Yocto 158 If you located this manual through a web search, the
155 Project, go to the 159 version of the manual might not be the one you want
160 (e.g. the search might have returned a manual much
161 older than the Yocto Project version with which you
162 are working).
163 You can see all Yocto Project major releases by
164 visiting the
165 <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
166 page.
167 If you need a version of this manual for a different
168 Yocto Project release, visit the
156 <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> 169 <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
157 and use the drop-down "Active Releases" button 170 and select the manual set by using the
158 and choose the manual associated with the desired 171 "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
159 Yocto Project. 172 pull-down menus.
160 </para></listitem> 173 </para></listitem>
161 <listitem><para> 174 <listitem><para>
162 To report any inaccuracies or problems with this 175 To report any inaccuracies or problems with this
163 manual, send an email to the Yocto Project 176 manual, send an email to the Yocto Project
164 discussion group at 177 discussion group at
165 <filename>yocto@yoctoproject.com</filename> or log into 178 <filename>yocto@yoctoproject.com</filename> or log into
166 the freenode <filename>#yocto</filename> channel. 179 the freenode <filename>#yocto</filename> channel.
167 </para></listitem> 180 </para></listitem>
168 </itemizedlist> 181 </itemizedlist>
169 </note> 182 </note>
170 </legalnotice> 183 </legalnotice>