From 7907cb7b6c0e4656bff5b02bd7b3a3d0bb9f4287 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 28 Mar 2018 09:17:48 -0700 Subject: Documentation: Updated Manual Notes I did some re-wording to account for when the user does a web search for a manual and the search returns an ancient version of the manual. Many times the user is oblivious of this fact and is trying to use a version of the docs that don't come close to matching the version of the YP. (From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../brief-yoctoprojectqs/brief-yoctoprojectqs.xml | 58 ++++++++++++++-------- documentation/bsp-guide/bsp-guide.xml | 38 +++++++++----- documentation/concepts-manual/concepts-manual.xml | 38 +++++++++----- documentation/dev-manual/dev-manual.xml | 38 +++++++++----- documentation/getting-started/getting-started.xml | 42 ++++++++++------ documentation/kernel-dev/kernel-dev.xml | 38 +++++++++----- documentation/mega-manual/mega-manual.xml | 38 +++++++++----- documentation/profile-manual/profile-manual.xml | 38 +++++++++----- documentation/ref-manual/ref-manual.xml | 38 +++++++++----- documentation/sdk-manual/sdk-manual.xml | 39 +++++++++------ documentation/toaster-manual/toaster-manual.xml | 38 +++++++++----- .../yocto-project-qs/yocto-project-qs.xml | 38 +++++++++----- 12 files changed, 315 insertions(+), 166 deletions(-) (limited to 'documentation') diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml index 356bd521fd..ee7f7b421d 100644 --- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml +++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml @@ -17,26 +17,44 @@ the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons. diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml index 5df7e887f4..2d25b578e2 100644 --- a/documentation/bsp-guide/bsp-guide.xml +++ b/documentation/bsp-guide/bsp-guide.xml @@ -141,24 +141,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/concepts-manual/concepts-manual.xml b/documentation/concepts-manual/concepts-manual.xml index 5057804f68..2d50792de6 100644 --- a/documentation/concepts-manual/concepts-manual.xml +++ b/documentation/concepts-manual/concepts-manual.xml @@ -58,24 +58,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 aaeb4e7576..c9b3a4c4d3 100644 --- a/documentation/dev-manual/dev-manual.xml +++ b/documentation/dev-manual/dev-manual.xml @@ -128,24 +128,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/getting-started/getting-started.xml b/documentation/getting-started/getting-started.xml index 8ce35fbc5d..19f869eb21 100644 --- a/documentation/getting-started/getting-started.xml +++ b/documentation/getting-started/getting-started.xml @@ -54,28 +54,40 @@ This version of the - Getting Started With Yocto Project Manual - is for the &YOCTO_DOC_VERSION; release of the + Getting Started With Yocto Project + 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/kernel-dev/kernel-dev.xml b/documentation/kernel-dev/kernel-dev.xml index f697e3cb9d..941c863bdf 100644 --- a/documentation/kernel-dev/kernel-dev.xml +++ b/documentation/kernel-dev/kernel-dev.xml @@ -111,24 +111,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 642b1b491c..344634033e 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml @@ -95,24 +95,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 3f8f93a3ae..098e105f29 100644 --- a/documentation/profile-manual/profile-manual.xml +++ b/documentation/profile-manual/profile-manual.xml @@ -113,24 +113,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 dbcc28bcd6..16bd5781c8 100644 --- a/documentation/ref-manual/ref-manual.xml +++ b/documentation/ref-manual/ref-manual.xml @@ -142,24 +142,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 cf59f5a0f7..53bda1a292 100644 --- a/documentation/sdk-manual/sdk-manual.xml +++ b/documentation/sdk-manual/sdk-manual.xml @@ -76,27 +76,38 @@ 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 21fadfca57..5bc584aeaa 100644 --- a/documentation/toaster-manual/toaster-manual.xml +++ b/documentation/toaster-manual/toaster-manual.xml @@ -86,24 +86,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 12ca05b930..7592d3a595 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -143,24 +143,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. + -- cgit v1.2.3-54-g00ecf