From 24344d55043db843ed643aac16932f908c628684 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 28 Mar 2018 12:26:45 -0700 Subject: [PATCH] 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 Signed-off-by: Richard Purdie --- documentation/bsp-guide/bsp-guide.xml | 68 +++++++++++-------- documentation/dev-manual/dev-manual.xml | 66 +++++++++++------- documentation/kernel-dev/kernel-dev.xml | 55 +++++++++------ documentation/mega-manual/mega-manual.xml | 48 ++++++++----- .../profile-manual/profile-manual.xml | 67 ++++++++++-------- documentation/ref-manual/ref-manual.xml | 54 +++++++++------ documentation/sdk-manual/sdk-manual.xml | 49 ++++++++----- .../toaster-manual/toaster-manual.xml | 48 ++++++++----- .../yocto-project-qs/yocto-project-qs.xml | 67 ++++++++++-------- 9 files changed, 321 insertions(+), 201 deletions(-) diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml index f0ee3991c6..d08df5ebba 100644 --- a/documentation/bsp-guide/bsp-guide.xml +++ b/documentation/bsp-guide/bsp-guide.xml @@ -150,34 +150,46 @@ 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 - - - For the latest version of the Yocto Project Board - Support Package (BSP) Developer's Guide associated with - this Yocto Project release (version - &YOCTO_DOC_VERSION;), - see the Yocto Project Board Support Package (BSP) - Developer's Guide from the - Yocto Project documentation page. - - - This version of the manual is version - &YOCTO_DOC_VERSION;. - For later releases of the Yocto Project (if they exist), - go to the - Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the Yocto Project version for which you want - the manual. - - - For an in-development version of the Yocto Project - Board Support Package (BSP) Developer's Guide, see - . - - - + Manual Notes + + + This version of the + Yocto Project Board Support Package (BSP) Developer's Guide + 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. + + + diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml index 26ee974e42..e25343b3be 100644 --- a/documentation/dev-manual/dev-manual.xml +++ b/documentation/dev-manual/dev-manual.xml @@ -131,32 +131,46 @@ Creative Commons. - Manual Notes - - - For the latest version of the Yocto Project Development - Manual associated with this Yocto Project release - (version &YOCTO_DOC_VERSION;), - see the Yocto Project Development Manual from the - Yocto Project documentation page. - - - This version of the manual is version - &YOCTO_DOC_VERSION;. - For later releases of the Yocto Project (if they exist), - go to the - Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the Yocto Project version for which you want - the manual. - - - For an in-development version of the Yocto Project - Development Manual, see - . - - - + Manual Notes + + + This version of the + Yocto Project Development 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, 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. + + + diff --git a/documentation/kernel-dev/kernel-dev.xml b/documentation/kernel-dev/kernel-dev.xml index 28a3364084..cbb4a746b7 100644 --- a/documentation/kernel-dev/kernel-dev.xml +++ b/documentation/kernel-dev/kernel-dev.xml @@ -116,30 +116,43 @@ Manual Notes - For the latest version of the Yocto Project Linux - Kernel Development Manual associated with this Yocto - Project release (version &YOCTO_DOC_VERSION;), - see the Yocto Project Linux Kernel Development - Manual from the - Yocto Project documentation page. - - - This version of the manual is version - &YOCTO_DOC_VERSION;. - For later releases of the Yocto Project (if they exist), - go to the + This version of the + Yocto Project Linux Kernel Development 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, go to the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the Yocto Project version for which you want - the manual. + 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 an in-development version of the Yocto Project - Linux Kernel Development Manual, see - . - - - + 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. + + + diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml index d06f851374..901dcf2462 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml @@ -100,26 +100,40 @@ Manual Notes - For the latest version of the Yocto Project - Mega-Manual associated with this Yocto Project release - (version &YOCTO_DOC_VERSION;), - see the Yocto Project Mega-Manual from the - Yocto Project documentation page. - - - This version of the manual is version - &YOCTO_DOC_VERSION;. - For later releases of the Yocto Project (if they exist), - go to the + This version of the + Yocto Project Mega-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, go to the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the Yocto Project version for which you want - the manual. + 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 an in-development version of the Yocto Project - Mega-Manual, see - . + 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. diff --git a/documentation/profile-manual/profile-manual.xml b/documentation/profile-manual/profile-manual.xml index b668fd47ad..3aee79ef3a 100644 --- a/documentation/profile-manual/profile-manual.xml +++ b/documentation/profile-manual/profile-manual.xml @@ -116,33 +116,46 @@ Creative Commons. - Manual Notes - - - For the latest version of the Yocto Project Profiling - and Tracing Manual associated with this Yocto Project - release (version &YOCTO_DOC_VERSION;), - see the Yocto Project Profiling and Tracing Manual - from the - Yocto Project documentation page. - - - This version of the manual is version - &YOCTO_DOC_VERSION;. - For later releases of the Yocto Project (if they exist), - go to the - Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the Yocto Project version for which you want - the manual. - - - For an in-development version of the Yocto Project - Profiling and Tracing Manual, see - . - - - + Manual Notes + + + This version of the + Yocto Project Profiling and Tracing 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, 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. + + + diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml index 752b210152..04825105c2 100644 --- a/documentation/ref-manual/ref-manual.xml +++ b/documentation/ref-manual/ref-manual.xml @@ -147,29 +147,43 @@ Manual Notes - For the latest version of the Yocto Project Reference - Manual associated with this Yocto Project release - (version &YOCTO_DOC_VERSION;), - see the Yocto Project Reference Manual from the - Yocto Project documentation page. - - - This version of the manual is version - &YOCTO_DOC_VERSION;. - For later releases of the Yocto Project (if they exist), - go to the + This version of the + Yocto Project Reference 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, go to the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the Yocto Project version for which you want - the manual. + 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 an in-development version of the Yocto Project - Reference Manual, see - . - - - + 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. + + + diff --git a/documentation/sdk-manual/sdk-manual.xml b/documentation/sdk-manual/sdk-manual.xml index 5c28e34eb0..20df2be202 100644 --- a/documentation/sdk-manual/sdk-manual.xml +++ b/documentation/sdk-manual/sdk-manual.xml @@ -81,27 +81,40 @@ Manual Notes - For the latest version of the Yocto Project Software - Development Kit (SDK) Developer's Guide associated with - this Yocto Project release (version &YOCTO_DOC_VERSION;), - see the Yocto Project Software Development Kit (SDK) - Developer's Guide from the - Yocto Project documentation page. - - - This version of the manual is version - &YOCTO_DOC_VERSION;. - For later releases of the Yocto Project (if they exist), - go to the + This version of the + Yocto Project Software Development Kit (SDK) Developer's Guide + 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 use the drop-down "Active Releases" button - and choose the Yocto Project version for which you want - the manual. + 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 an in-development version of the Yocto Project - Software Development Kit (SDK) Developer's Guide, see - . + 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. diff --git a/documentation/toaster-manual/toaster-manual.xml b/documentation/toaster-manual/toaster-manual.xml index c7a7fcd787..46b0e84669 100644 --- a/documentation/toaster-manual/toaster-manual.xml +++ b/documentation/toaster-manual/toaster-manual.xml @@ -91,26 +91,40 @@ Manual Notes - For the latest version of the Yocto Project Toaster - User Manual associated with this Yocto Project release - (version &YOCTO_DOC_VERSION;), - see the Yocto Project Toaster User Manual from the - Yocto Project documentation page. - - - This version of the manual is version - &YOCTO_DOC_VERSION;. - For later releases of the Yocto Project (if they exist), - go to the + This version of the + Toaster User 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, go to the Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the Yocto Project version for which you want - the manual. + 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 an in-development version of the Yocto Project - Toaster User Manual, see - . + 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. diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index b4b3f4bd0e..063b55c47d 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -16,35 +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 - - - For the latest version of the Yocto Project Quick - Start associated with this Yocto Project release - (version &YOCTO_DOC_VERSION;), - see the Yocto Project Quick Start from the - Yocto Project documentation page. - - - This version of the manual is version - &YOCTO_DOC_VERSION;. - For later releases of the Yocto Project (if they exist), - go to the - Yocto Project documentation page - and use the drop-down "Active Releases" button - and choose the Yocto Project version for which you want - the manual. - - - For an in-development version of the Yocto Project - Quick Start, see - . - - - + 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. + + + -