diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-03-28 10:34:17 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-05-29 11:41:57 +0100 |
commit | ef4bb21693832d68dcdf6f78208591df029ac02b (patch) | |
tree | 49da74bd1ac14399e3a9deaa81b77f59d308a53f /documentation/sdk-manual | |
parent | 9c3da34ec6c2c9a9abc30c72d6a8f9b996250862 (diff) | |
download | poky-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/sdk-manual')
-rw-r--r-- | documentation/sdk-manual/sdk-manual.xml | 39 |
1 files changed, 26 insertions, 13 deletions
diff --git a/documentation/sdk-manual/sdk-manual.xml b/documentation/sdk-manual/sdk-manual.xml index 7fc0472cd7..876bb2cf7d 100644 --- a/documentation/sdk-manual/sdk-manual.xml +++ b/documentation/sdk-manual/sdk-manual.xml | |||
@@ -73,6 +73,7 @@ | |||
73 | Permission is granted to copy, distribute and/or modify this document under | 73 | Permission is granted to copy, distribute and/or modify this document under |
74 | 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 & Wales</ulink> as published by Creative Commons. | 74 | 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 & Wales</ulink> as published by Creative Commons. |
75 | </para> | 75 | </para> |
76 | |||
76 | <note><title>Manual Notes</title> | 77 | <note><title>Manual Notes</title> |
77 | <itemizedlist> | 78 | <itemizedlist> |
78 | <listitem><para> | 79 | <listitem><para> |
@@ -81,24 +82,36 @@ | |||
81 | manual is for the &YOCTO_DOC_VERSION; release of the | 82 | manual is for the &YOCTO_DOC_VERSION; release of the |
82 | Yocto Project. | 83 | Yocto Project. |
83 | To be sure you have the latest version of the manual | 84 | To be sure you have the latest version of the manual |
84 | for this release, use the manual from the | 85 | for this release, go to the |
85 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. | 86 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> |
87 | and select the manual from that site. | ||
88 | Manuals from the site are more up-to-date than manuals | ||
89 | derived from the Yocto Project released TAR files. | ||
86 | </para></listitem> | 90 | </para></listitem> |
87 | <listitem><para> | 91 | <listitem><para> |
88 | For manuals associated with other releases of the Yocto | 92 | If you located this manual through a web search, the |
89 | Project, go to the | 93 | version of the manual might not be the one you want |
94 | (e.g. the search might have returned a manual much | ||
95 | older than the Yocto Project version with which you | ||
96 | are working). | ||
97 | You can see all Yocto Project major releases by | ||
98 | visiting the | ||
99 | <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink> | ||
100 | page. | ||
101 | If you need a version of this manual for a different | ||
102 | Yocto Project release, visit the | ||
90 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | 103 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> |
91 | and use the drop-down "Active Releases" button | 104 | and select the manual set by using the |
92 | and choose the manual associated with the desired | 105 | "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" |
93 | Yocto Project. | 106 | pull-down menus. |
94 | </para></listitem> | 107 | </para></listitem> |
95 | <listitem><para> | 108 | <listitem><para> |
96 | To report any inaccuracies or problems with this | 109 | To report any inaccuracies or problems with this |
97 | manual, send an email to the Yocto Project | 110 | manual, send an email to the Yocto Project |
98 | discussion group at | 111 | discussion group at |
99 | <filename>yocto@yoctoproject.com</filename> or log into | 112 | <filename>yocto@yoctoproject.com</filename> or log into |
100 | the freenode <filename>#yocto</filename> channel. | 113 | the freenode <filename>#yocto</filename> channel. |
101 | </para></listitem> | 114 | </para></listitem> |
102 | </itemizedlist> | 115 | </itemizedlist> |
103 | </note> | 116 | </note> |
104 | 117 | ||