From ef4bb21693832d68dcdf6f78208591df029ac02b Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 28 Mar 2018 10:34:17 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/bsp-guide/bsp-guide.xml | 38 +++++++++----- documentation/dev-manual/dev-manual.xml | 39 ++++++++++----- documentation/kernel-dev/kernel-dev.xml | 38 +++++++++----- documentation/mega-manual/mega-manual.xml | 38 +++++++++----- documentation/profile-manual/profile-manual.xml | 39 ++++++++++----- documentation/ref-manual/ref-manual.xml | 39 ++++++++++----- documentation/sdk-manual/sdk-manual.xml | 39 ++++++++++----- documentation/toaster-manual/toaster-manual.xml | 38 +++++++++----- .../yocto-project-qs/yocto-project-qs.xml | 58 ++++++++++++++-------- 9 files changed, 240 insertions(+), 126 deletions(-) diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml index 576ed18b15..38ab549a33 100644 --- a/documentation/bsp-guide/bsp-guide.xml +++ b/documentation/bsp-guide/bsp-guide.xml @@ -146,24 +146,36 @@ is for the &YOCTO_DOC_VERSION; release of the Yocto Project. To be sure you have the latest version of the manual - for this release, use the manual from the - Yocto Project documentation page. + for this release, go to the + Yocto Project documentation page + 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. - For manuals associated with other releases of the Yocto - Project, go to the + If you located this manual through a web search, 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 + Releases + page. + If you need a version of this manual for a different + Yocto Project release, visit the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the manual associated with the desired - Yocto Project. + and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" + pull-down menus. - To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - yocto@yoctoproject.com or log into - the freenode #yocto channel. - + To report any inaccuracies or problems with this + manual, send an email to the Yocto Project + discussion group at + yocto@yoctoproject.com or log into + the freenode #yocto channel. + diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml index ed8011dc1c..512706e344 100644 --- a/documentation/dev-manual/dev-manual.xml +++ b/documentation/dev-manual/dev-manual.xml @@ -125,6 +125,7 @@ Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons. + Manual Notes @@ -133,24 +134,36 @@ is for the &YOCTO_DOC_VERSION; release of the Yocto Project. To be sure you have the latest version of the manual - for this release, use the manual from the - Yocto Project documentation page. + for this release, go to the + Yocto Project documentation page + 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. - For manuals associated with other releases of the Yocto - Project, go to the + If you located this manual through a web search, 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 + Releases + page. + If you need a version of this manual for a different + Yocto Project release, visit the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the manual associated with the desired - Yocto Project. + and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" + pull-down menus. - To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - yocto@yoctoproject.com or log into - the freenode #yocto channel. - + To report any inaccuracies or problems with this + manual, send an email to the Yocto Project + discussion group at + yocto@yoctoproject.com or log into + the freenode #yocto channel. + diff --git a/documentation/kernel-dev/kernel-dev.xml b/documentation/kernel-dev/kernel-dev.xml index ec36d24491..07b20f8493 100644 --- a/documentation/kernel-dev/kernel-dev.xml +++ b/documentation/kernel-dev/kernel-dev.xml @@ -116,24 +116,36 @@ is for the &YOCTO_DOC_VERSION; release of the Yocto Project. To be sure you have the latest version of the manual - for this release, use the manual from the - Yocto Project documentation page. + for this release, go to the + Yocto Project documentation page + 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. - For manuals associated with other releases of the Yocto - Project, go to the + If you located this manual through a web search, 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 + Releases + page. + If you need a version of this manual for a different + Yocto Project release, visit the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the manual associated with the desired - Yocto Project. + and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" + pull-down menus. - To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - yocto@yoctoproject.com or log into - the freenode #yocto channel. - + To report any inaccuracies or problems with this + manual, send an email to the Yocto Project + discussion group at + yocto@yoctoproject.com or log into + the freenode #yocto channel. + diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml index a941d799a1..744c969753 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml @@ -100,24 +100,36 @@ is for the &YOCTO_DOC_VERSION; release of the Yocto Project. To be sure you have the latest version of the manual - for this release, use the manual from the - Yocto Project documentation page. + for this release, go to the + Yocto Project documentation page + 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. - For manuals associated with other releases of the Yocto - Project, go to the + If you located this manual through a web search, 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 + Releases + page. + If you need a version of this manual for a different + Yocto Project release, visit the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the manual associated with the desired - Yocto Project. + and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" + pull-down menus. - To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - yocto@yoctoproject.com or log into - the freenode #yocto channel. - + To report any inaccuracies or problems with this + manual, send an email to the Yocto Project + discussion group at + yocto@yoctoproject.com or log into + the freenode #yocto channel. + diff --git a/documentation/profile-manual/profile-manual.xml b/documentation/profile-manual/profile-manual.xml index f742e88718..deb3ddaae7 100644 --- a/documentation/profile-manual/profile-manual.xml +++ b/documentation/profile-manual/profile-manual.xml @@ -110,6 +110,7 @@ Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons. + Manual Notes @@ -118,24 +119,36 @@ is for the &YOCTO_DOC_VERSION; release of the Yocto Project. To be sure you have the latest version of the manual - for this release, use the manual from the - Yocto Project documentation page. + for this release, go to the + Yocto Project documentation page + 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. - For manuals associated with other releases of the Yocto - Project, go to the + If you located this manual through a web search, 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 + Releases + page. + If you need a version of this manual for a different + Yocto Project release, visit the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the manual associated with the desired - Yocto Project. + and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" + pull-down menus. - To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - yocto@yoctoproject.com or log into - the freenode #yocto channel. - + To report any inaccuracies or problems with this + manual, send an email to the Yocto Project + discussion group at + yocto@yoctoproject.com or log into + the freenode #yocto channel. + 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 @@ Permission is granted to copy, distribute and/or modify this document under the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons. + Manual Notes @@ -147,24 +148,36 @@ is for the &YOCTO_DOC_VERSION; release of the Yocto Project. To be sure you have the latest version of the manual - for this release, use the manual from the - Yocto Project documentation page. + for this release, go to the + Yocto Project documentation page + 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. - For manuals associated with other releases of the Yocto - Project, go to the + If you located this manual through a web search, 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 + Releases + page. + If you need a version of this manual for a different + Yocto Project release, visit the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the manual associated with the desired - Yocto Project. + and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" + pull-down menus. - To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - yocto@yoctoproject.com or log into - the freenode #yocto channel. - + To report any inaccuracies or problems with this + manual, send an email to the Yocto Project + discussion group at + yocto@yoctoproject.com or log into + the freenode #yocto channel. + 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 @@ Permission is granted to copy, distribute and/or modify this document under the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons. + Manual Notes @@ -81,24 +82,36 @@ manual is for the &YOCTO_DOC_VERSION; release of the Yocto Project. To be sure you have the latest version of the manual - for this release, use the manual from the - Yocto Project documentation page. + for this release, go to the + Yocto Project documentation page + 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. - For manuals associated with other releases of the Yocto - Project, go to the + If you located this manual through a web search, 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 + Releases + page. + If you need a version of this manual for a different + Yocto Project release, visit the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the manual associated with the desired - Yocto Project. + and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" + pull-down menus. - To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - yocto@yoctoproject.com or log into - the freenode #yocto channel. - + To report any inaccuracies or problems with this + manual, send an email to the Yocto Project + discussion group at + yocto@yoctoproject.com or log into + the freenode #yocto channel. + diff --git a/documentation/toaster-manual/toaster-manual.xml b/documentation/toaster-manual/toaster-manual.xml index 5a1b60e58c..fa3f67e098 100644 --- a/documentation/toaster-manual/toaster-manual.xml +++ b/documentation/toaster-manual/toaster-manual.xml @@ -91,24 +91,36 @@ is for the &YOCTO_DOC_VERSION; release of the Yocto Project. To be sure you have the latest version of the manual - for this release, use the manual from the - Yocto Project documentation page. + for this release, go to the + Yocto Project documentation page + 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. - For manuals associated with other releases of the Yocto - Project, go to the + If you located this manual through a web search, 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 + Releases + page. + If you need a version of this manual for a different + Yocto Project release, visit the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the manual associated with the desired - Yocto Project. + and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" + pull-down menus. - To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - yocto@yoctoproject.com or log into - the freenode #yocto channel. - + To report any inaccuracies or problems with this + manual, send an email to the Yocto Project + discussion group at + yocto@yoctoproject.com or log into + the freenode #yocto channel. + diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index e6dae7ffe3..4ea918058f 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -16,34 +16,48 @@ Permission is granted to copy, distribute and/or modify this document under the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons. - Manual Notes - - - This version of the - Yocto Project Quick Start - is for the &YOCTO_DOC_VERSION; release of the - Yocto Project. - To be sure you have the latest version of the manual - for this release, use the manual from the - Yocto Project documentation page. - - - For manuals associated with other releases of the Yocto - Project, go to the - Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the manual associated with the desired - Yocto Project. - - + + Manual Notes + + + This version of the + Yocto Project Quick Start + is for the &YOCTO_DOC_VERSION; release of the + Yocto Project. + To be sure you have the latest version of the manual + for this release, go to the + Yocto Project documentation page + 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. + + + If you located this manual through a web search, 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 + Releases + page. + If you need a version of this manual for a different + Yocto Project release, visit the + Yocto Project documentation page + and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" + pull-down menus. + + To report any inaccuracies or problems with this manual, send an email to the Yocto Project discussion group at yocto@yoctoproject.com or log into the freenode #yocto channel. - - + + + -- cgit v1.2.3-54-g00ecf