diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2017-02-03 10:52:44 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-02-19 06:59:51 -0800 |
commit | 77afd14e817677810868de82b77a4682052b6f95 (patch) | |
tree | 97e1bea9dee832491c0de40c3da27374c19f6fb9 | |
parent | 23bd7e100adb6dc06c4992ff5863f01d0b39e75b (diff) | |
download | openembedded-core-contrib-77afd14e817677810868de82b77a4682052b6f95.tar.gz |
documentation: Updated "latest manual" note on title page
Fixes [YOCTO #10076]
The note on the title page for each manual was brief regarding
where to find the latest version of the manual. I updated the
note to have more detailed information on finding current,
alternate, and latest versions of the manual based on YP
releases.
(From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/bsp-guide/bsp-guide.xml | 34 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual.xml | 32 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev.xml | 33 | ||||
-rw-r--r-- | documentation/mega-manual/mega-manual.xml | 32 | ||||
-rw-r--r-- | documentation/profile-manual/profile-manual.xml | 33 | ||||
-rw-r--r-- | documentation/ref-manual/ref-manual.xml | 32 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-manual.xml | 33 | ||||
-rw-r--r-- | documentation/toaster-manual/toaster-manual.xml | 32 | ||||
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 17 |
9 files changed, 224 insertions, 54 deletions
diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml index 9eaa078873..848ff7bf6c 100644 --- a/documentation/bsp-guide/bsp-guide.xml +++ b/documentation/bsp-guide/bsp-guide.xml @@ -130,12 +130,34 @@ Permission is granted to copy, distribute and/or modify this document under the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-nc-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</ulink> as published by Creative Commons. </para> - <note> - For the latest version of this manual associated with this - Yocto Project release, see the - <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink> - from the Yocto Project website. - </note> + <note><title>Manual Notes</title> + <itemizedlist> + <listitem><para> + 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 + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. + </para></listitem> + <listitem><para> + This version of the manual is version + &YOCTO_DOC_VERSION;. + For later releases of the Yocto Project (if they exist), + go to the + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. + </para></listitem> + <listitem><para> + For an in-development version of the Yocto Project + Board Support Package (BSP) Developer's Guide, see + <ulink url='&YOCTO_DOCS_URL;/latest/bsp-guide/bsp-guide.html'></ulink>. + </para></listitem> + </itemizedlist> + </note> </legalnotice> </bookinfo> diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml index 1b8b1f3700..86ba573aa8 100644 --- a/documentation/dev-manual/dev-manual.xml +++ b/documentation/dev-manual/dev-manual.xml @@ -111,12 +111,32 @@ Creative Commons. </para> - <note> - For the latest version of this manual associated with this - Yocto Project release, see the - <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink> - from the Yocto Project website. - </note> + <note><title>Manual Notes</title> + <itemizedlist> + <listitem><para> + 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 + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. + </para></listitem> + <listitem><para> + This version of the manual is version + &YOCTO_DOC_VERSION;. + For later releases of the Yocto Project (if they exist), + go to the + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. + </para></listitem> + <listitem><para> + For an in-development version of the Yocto Project + Development Manual, see + <ulink url='&YOCTO_DOCS_URL;/latest/dev-manual/dev-manual.html'></ulink>. + </para></listitem> + </itemizedlist> + </note> </legalnotice> </bookinfo> diff --git a/documentation/kernel-dev/kernel-dev.xml b/documentation/kernel-dev/kernel-dev.xml index 7e3471a736..5e90113300 100644 --- a/documentation/kernel-dev/kernel-dev.xml +++ b/documentation/kernel-dev/kernel-dev.xml @@ -93,12 +93,33 @@ Permission is granted to copy, distribute and/or modify this document under 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. </para> - <note> - For the latest version of this manual associated with this - Yocto Project release, see the - <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink> - from the Yocto Project website. - </note> + <note><title>Manual Notes</title> + <itemizedlist> + <listitem><para> + 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 + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. + </para></listitem> + <listitem><para> + This version of the manual is version + &YOCTO_DOC_VERSION;. + For later releases of the Yocto Project (if they exist), + go to the + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. + </para></listitem> + <listitem><para> + For an in-development version of the Yocto Project + Linux Kernel Development Manual, see + <ulink url='&YOCTO_DOCS_URL;/latest/kernel-dev/kernel-dev.html'></ulink>. + </para></listitem> + </itemizedlist> + </note> </legalnotice> </bookinfo> diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml index 1acdc1e572..4f03864b2d 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml @@ -77,12 +77,32 @@ Permission is granted to copy, distribute and/or modify this document under 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. </para> - <note> - For the latest version of this manual associated with this - Yocto Project release, see the - <ulink url='&YOCTO_DOCS_MM_URL;'>Yocto Project Mega-Manual</ulink> - from the Yocto Project website. - </note> + <note><title>Manual Notes</title> + <itemizedlist> + <listitem><para> + 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 + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. + </para></listitem> + <listitem><para> + This version of the manual is version + &YOCTO_DOC_VERSION;. + For later releases of the Yocto Project (if they exist), + go to the + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. + </para></listitem> + <listitem><para> + For an in-development version of the Yocto Project + Mega-Manual, see + <ulink url='&YOCTO_DOCS_URL;/latest/mega-manual/mega-manual.html'></ulink>. + </para></listitem> + </itemizedlist> + </note> </legalnotice> diff --git a/documentation/profile-manual/profile-manual.xml b/documentation/profile-manual/profile-manual.xml index 21841cec79..1457d69648 100644 --- a/documentation/profile-manual/profile-manual.xml +++ b/documentation/profile-manual/profile-manual.xml @@ -96,12 +96,33 @@ Creative Commons. </para> - <note> - For the latest version of this manual associated with this - Yocto Project release, see the - <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink> - from the Yocto Project website. - </note> + <note><title>Manual Notes</title> + <itemizedlist> + <listitem><para> + 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 + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. + </para></listitem> + <listitem><para> + This version of the manual is version + &YOCTO_DOC_VERSION;. + For later releases of the Yocto Project (if they exist), + go to the + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. + </para></listitem> + <listitem><para> + For an in-development version of the Yocto Project + Profiling and Tracing Manual, see + <ulink url='&YOCTO_DOCS_URL;/latest/profile-manual/profile-manual.html'></ulink>. + </para></listitem> + </itemizedlist> + </note> </legalnotice> </bookinfo> diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml index 4e492baed6..3c8e63fe22 100644 --- a/documentation/ref-manual/ref-manual.xml +++ b/documentation/ref-manual/ref-manual.xml @@ -124,12 +124,32 @@ Permission is granted to copy, distribute and/or modify this document under 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. </para> - <note> - For the latest version of this manual associated with this - Yocto Project release, see the - <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink> - from the Yocto Project website. - </note> + <note><title>Manual Notes</title> + <itemizedlist> + <listitem><para> + 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 + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. + </para></listitem> + <listitem><para> + This version of the manual is version + &YOCTO_DOC_VERSION;. + For later releases of the Yocto Project (if they exist), + go to the + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. + </para></listitem> + <listitem><para> + For an in-development version of the Yocto Project + Reference Manual, see + <ulink url='&YOCTO_DOCS_URL;/latest/ref-manual/ref-manual.html'></ulink>. + </para></listitem> + </itemizedlist> + </note> </legalnotice> </bookinfo> diff --git a/documentation/sdk-manual/sdk-manual.xml b/documentation/sdk-manual/sdk-manual.xml index 4a891910ba..be92a304fe 100644 --- a/documentation/sdk-manual/sdk-manual.xml +++ b/documentation/sdk-manual/sdk-manual.xml @@ -58,12 +58,33 @@ Permission is granted to copy, distribute and/or modify this document under 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. </para> - <note> - For the latest version of this manual associated with this - Yocto Project release, see the - <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink> - from the Yocto Project website. - </note> + <note><title>Manual Notes</title> + <itemizedlist> + <listitem><para> + 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 + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. + </para></listitem> + <listitem><para> + This version of the manual is version + &YOCTO_DOC_VERSION;. + For later releases of the Yocto Project (if they exist), + go to the + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. + </para></listitem> + <listitem><para> + For an in-development version of the Yocto Project + Software Development Kit (SDK) Developer's Guide, see + <ulink url='&YOCTO_DOCS_URL;/latest/sdk-manual/sdk-manual.html'></ulink>. + </para></listitem> + </itemizedlist> + </note> </legalnotice> diff --git a/documentation/toaster-manual/toaster-manual.xml b/documentation/toaster-manual/toaster-manual.xml index 840d60cbb5..2b9000c32e 100644 --- a/documentation/toaster-manual/toaster-manual.xml +++ b/documentation/toaster-manual/toaster-manual.xml @@ -68,12 +68,32 @@ Permission is granted to copy, distribute and/or modify this document under 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. </para> - <note> - For the latest version of this manual associated with this - Yocto Project release, see the - <ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink> - from the Yocto Project website. - </note> + <note><title>Manual Notes</title> + <itemizedlist> + <listitem><para> + 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 + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. + </para></listitem> + <listitem><para> + This version of the manual is version + &YOCTO_DOC_VERSION;. + For later releases of the Yocto Project (if they exist), + go to the + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. + </para></listitem> + <listitem><para> + For an in-development version of the Yocto Project + Toaster User Manual, see + <ulink url='&YOCTO_DOCS_URL;/latest/toaster-manual/toaster-manual.html'></ulink>. + </para></listitem> + </itemizedlist> + </note> </legalnotice> diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 118a1c15aa..3e133a6e06 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -20,15 +20,20 @@ <itemizedlist> <listitem><para> For the latest version of the Yocto Project Quick - Start associated with this Yocto Project release, + Start associated with this Yocto Project release + (version &YOCTO_DOC_VERSION;), see the Yocto Project Quick Start from the - <ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>. + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. </para></listitem> <listitem><para> - Later releases of the Yocto Project might exist and the - associated Yocto Project Quick Start for any later - release can be found at - <ulink url='&YOCTO_HOME_URL;/documentation'></ulink>. + This version of the manual is version + &YOCTO_DOC_VERSION;. + For later releases of the Yocto Project (if they exist), + go to the + <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. </para></listitem> <listitem><para> For an in-development version of the Yocto Project |