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 | poky-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 @@ | |||
130 | Permission is granted to copy, distribute and/or modify this document under | 130 | Permission is granted to copy, distribute and/or modify this document under |
131 | 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. | 131 | 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. |
132 | </para> | 132 | </para> |
133 | <note> | 133 | <note><title>Manual Notes</title> |
134 | For the latest version of this manual associated with this | 134 | <itemizedlist> |
135 | Yocto Project release, see the | 135 | <listitem><para> |
136 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink> | 136 | For the latest version of the Yocto Project Board |
137 | from the Yocto Project website. | 137 | Support Package (BSP) Developer's Guide associated with |
138 | </note> | 138 | this Yocto Project release (version |
139 | &YOCTO_DOC_VERSION;), | ||
140 | see the Yocto Project Board Support Package (BSP) | ||
141 | Developer's Guide from the | ||
142 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. | ||
143 | </para></listitem> | ||
144 | <listitem><para> | ||
145 | This version of the manual is version | ||
146 | &YOCTO_DOC_VERSION;. | ||
147 | For later releases of the Yocto Project (if they exist), | ||
148 | go to the | ||
149 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
150 | and use the drop-down "Active Releases" button | ||
151 | and choose the Yocto Project version for which you want | ||
152 | the manual. | ||
153 | </para></listitem> | ||
154 | <listitem><para> | ||
155 | For an in-development version of the Yocto Project | ||
156 | Board Support Package (BSP) Developer's Guide, see | ||
157 | <ulink url='&YOCTO_DOCS_URL;/latest/bsp-guide/bsp-guide.html'></ulink>. | ||
158 | </para></listitem> | ||
159 | </itemizedlist> | ||
160 | </note> | ||
139 | </legalnotice> | 161 | </legalnotice> |
140 | 162 | ||
141 | </bookinfo> | 163 | </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 @@ | |||
111 | Creative Commons. | 111 | Creative Commons. |
112 | </para> | 112 | </para> |
113 | 113 | ||
114 | <note> | 114 | <note><title>Manual Notes</title> |
115 | For the latest version of this manual associated with this | 115 | <itemizedlist> |
116 | Yocto Project release, see the | 116 | <listitem><para> |
117 | <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink> | 117 | For the latest version of the Yocto Project Development |
118 | from the Yocto Project website. | 118 | Manual associated with this Yocto Project release |
119 | </note> | 119 | (version &YOCTO_DOC_VERSION;), |
120 | see the Yocto Project Development Manual from the | ||
121 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. | ||
122 | </para></listitem> | ||
123 | <listitem><para> | ||
124 | This version of the manual is version | ||
125 | &YOCTO_DOC_VERSION;. | ||
126 | For later releases of the Yocto Project (if they exist), | ||
127 | go to the | ||
128 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
129 | and use the drop-down "Active Releases" button | ||
130 | and choose the Yocto Project version for which you want | ||
131 | the manual. | ||
132 | </para></listitem> | ||
133 | <listitem><para> | ||
134 | For an in-development version of the Yocto Project | ||
135 | Development Manual, see | ||
136 | <ulink url='&YOCTO_DOCS_URL;/latest/dev-manual/dev-manual.html'></ulink>. | ||
137 | </para></listitem> | ||
138 | </itemizedlist> | ||
139 | </note> | ||
120 | </legalnotice> | 140 | </legalnotice> |
121 | 141 | ||
122 | </bookinfo> | 142 | </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 @@ | |||
93 | Permission is granted to copy, distribute and/or modify this document under | 93 | Permission is granted to copy, distribute and/or modify this document under |
94 | 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. | 94 | 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. |
95 | </para> | 95 | </para> |
96 | <note> | 96 | <note><title>Manual Notes</title> |
97 | For the latest version of this manual associated with this | 97 | <itemizedlist> |
98 | Yocto Project release, see the | 98 | <listitem><para> |
99 | <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink> | 99 | For the latest version of the Yocto Project Linux |
100 | from the Yocto Project website. | 100 | Kernel Development Manual associated with this Yocto |
101 | </note> | 101 | Project release (version &YOCTO_DOC_VERSION;), |
102 | see the Yocto Project Linux Kernel Development | ||
103 | Manual from the | ||
104 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. | ||
105 | </para></listitem> | ||
106 | <listitem><para> | ||
107 | This version of the manual is version | ||
108 | &YOCTO_DOC_VERSION;. | ||
109 | For later releases of the Yocto Project (if they exist), | ||
110 | go to the | ||
111 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
112 | and use the drop-down "Active Releases" button | ||
113 | and choose the Yocto Project version for which you want | ||
114 | the manual. | ||
115 | </para></listitem> | ||
116 | <listitem><para> | ||
117 | For an in-development version of the Yocto Project | ||
118 | Linux Kernel Development Manual, see | ||
119 | <ulink url='&YOCTO_DOCS_URL;/latest/kernel-dev/kernel-dev.html'></ulink>. | ||
120 | </para></listitem> | ||
121 | </itemizedlist> | ||
122 | </note> | ||
102 | </legalnotice> | 123 | </legalnotice> |
103 | 124 | ||
104 | </bookinfo> | 125 | </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 @@ | |||
77 | Permission is granted to copy, distribute and/or modify this document under | 77 | Permission is granted to copy, distribute and/or modify this document under |
78 | 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. | 78 | 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. |
79 | </para> | 79 | </para> |
80 | <note> | 80 | <note><title>Manual Notes</title> |
81 | For the latest version of this manual associated with this | 81 | <itemizedlist> |
82 | Yocto Project release, see the | 82 | <listitem><para> |
83 | <ulink url='&YOCTO_DOCS_MM_URL;'>Yocto Project Mega-Manual</ulink> | 83 | For the latest version of the Yocto Project |
84 | from the Yocto Project website. | 84 | Mega-Manual associated with this Yocto Project release |
85 | </note> | 85 | (version &YOCTO_DOC_VERSION;), |
86 | see the Yocto Project Mega-Manual from the | ||
87 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. | ||
88 | </para></listitem> | ||
89 | <listitem><para> | ||
90 | This version of the manual is version | ||
91 | &YOCTO_DOC_VERSION;. | ||
92 | For later releases of the Yocto Project (if they exist), | ||
93 | go to the | ||
94 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
95 | and use the drop-down "Active Releases" button | ||
96 | and choose the Yocto Project version for which you want | ||
97 | the manual. | ||
98 | </para></listitem> | ||
99 | <listitem><para> | ||
100 | For an in-development version of the Yocto Project | ||
101 | Mega-Manual, see | ||
102 | <ulink url='&YOCTO_DOCS_URL;/latest/mega-manual/mega-manual.html'></ulink>. | ||
103 | </para></listitem> | ||
104 | </itemizedlist> | ||
105 | </note> | ||
86 | 106 | ||
87 | </legalnotice> | 107 | </legalnotice> |
88 | 108 | ||
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 @@ | |||
96 | Creative Commons. | 96 | Creative Commons. |
97 | </para> | 97 | </para> |
98 | 98 | ||
99 | <note> | 99 | <note><title>Manual Notes</title> |
100 | For the latest version of this manual associated with this | 100 | <itemizedlist> |
101 | Yocto Project release, see the | 101 | <listitem><para> |
102 | <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink> | 102 | For the latest version of the Yocto Project Profiling |
103 | from the Yocto Project website. | 103 | and Tracing Manual associated with this Yocto Project |
104 | </note> | 104 | release (version &YOCTO_DOC_VERSION;), |
105 | see the Yocto Project Profiling and Tracing Manual | ||
106 | from the | ||
107 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. | ||
108 | </para></listitem> | ||
109 | <listitem><para> | ||
110 | This version of the manual is version | ||
111 | &YOCTO_DOC_VERSION;. | ||
112 | For later releases of the Yocto Project (if they exist), | ||
113 | go to the | ||
114 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
115 | and use the drop-down "Active Releases" button | ||
116 | and choose the Yocto Project version for which you want | ||
117 | the manual. | ||
118 | </para></listitem> | ||
119 | <listitem><para> | ||
120 | For an in-development version of the Yocto Project | ||
121 | Profiling and Tracing Manual, see | ||
122 | <ulink url='&YOCTO_DOCS_URL;/latest/profile-manual/profile-manual.html'></ulink>. | ||
123 | </para></listitem> | ||
124 | </itemizedlist> | ||
125 | </note> | ||
105 | </legalnotice> | 126 | </legalnotice> |
106 | 127 | ||
107 | </bookinfo> | 128 | </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 @@ | |||
124 | Permission is granted to copy, distribute and/or modify this document under | 124 | Permission is granted to copy, distribute and/or modify this document under |
125 | 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. | 125 | 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. |
126 | </para> | 126 | </para> |
127 | <note> | 127 | <note><title>Manual Notes</title> |
128 | For the latest version of this manual associated with this | 128 | <itemizedlist> |
129 | Yocto Project release, see the | 129 | <listitem><para> |
130 | <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink> | 130 | For the latest version of the Yocto Project Reference |
131 | from the Yocto Project website. | 131 | Manual associated with this Yocto Project release |
132 | </note> | 132 | (version &YOCTO_DOC_VERSION;), |
133 | see the Yocto Project Reference Manual from the | ||
134 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. | ||
135 | </para></listitem> | ||
136 | <listitem><para> | ||
137 | This version of the manual is version | ||
138 | &YOCTO_DOC_VERSION;. | ||
139 | For later releases of the Yocto Project (if they exist), | ||
140 | go to the | ||
141 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
142 | and use the drop-down "Active Releases" button | ||
143 | and choose the Yocto Project version for which you want | ||
144 | the manual. | ||
145 | </para></listitem> | ||
146 | <listitem><para> | ||
147 | For an in-development version of the Yocto Project | ||
148 | Reference Manual, see | ||
149 | <ulink url='&YOCTO_DOCS_URL;/latest/ref-manual/ref-manual.html'></ulink>. | ||
150 | </para></listitem> | ||
151 | </itemizedlist> | ||
152 | </note> | ||
133 | </legalnotice> | 153 | </legalnotice> |
134 | 154 | ||
135 | </bookinfo> | 155 | </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 @@ | |||
58 | Permission is granted to copy, distribute and/or modify this document under | 58 | Permission is granted to copy, distribute and/or modify this document under |
59 | 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. | 59 | 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. |
60 | </para> | 60 | </para> |
61 | <note> | 61 | <note><title>Manual Notes</title> |
62 | For the latest version of this manual associated with this | 62 | <itemizedlist> |
63 | Yocto Project release, see the | 63 | <listitem><para> |
64 | <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink> | 64 | For the latest version of the Yocto Project Software |
65 | from the Yocto Project website. | 65 | Development Kit (SDK) Developer's Guide associated with |
66 | </note> | 66 | this Yocto Project release (version &YOCTO_DOC_VERSION;), |
67 | see the Yocto Project Software Development Kit (SDK) | ||
68 | Developer's Guide from the | ||
69 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. | ||
70 | </para></listitem> | ||
71 | <listitem><para> | ||
72 | This version of the manual is version | ||
73 | &YOCTO_DOC_VERSION;. | ||
74 | For later releases of the Yocto Project (if they exist), | ||
75 | go to the | ||
76 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
77 | and use the drop-down "Active Releases" button | ||
78 | and choose the Yocto Project version for which you want | ||
79 | the manual. | ||
80 | </para></listitem> | ||
81 | <listitem><para> | ||
82 | For an in-development version of the Yocto Project | ||
83 | Software Development Kit (SDK) Developer's Guide, see | ||
84 | <ulink url='&YOCTO_DOCS_URL;/latest/sdk-manual/sdk-manual.html'></ulink>. | ||
85 | </para></listitem> | ||
86 | </itemizedlist> | ||
87 | </note> | ||
67 | 88 | ||
68 | </legalnotice> | 89 | </legalnotice> |
69 | 90 | ||
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 @@ | |||
68 | Permission is granted to copy, distribute and/or modify this document under | 68 | Permission is granted to copy, distribute and/or modify this document under |
69 | 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. | 69 | 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. |
70 | </para> | 70 | </para> |
71 | <note> | 71 | <note><title>Manual Notes</title> |
72 | For the latest version of this manual associated with this | 72 | <itemizedlist> |
73 | Yocto Project release, see the | 73 | <listitem><para> |
74 | <ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink> | 74 | For the latest version of the Yocto Project Toaster |
75 | from the Yocto Project website. | 75 | User Manual associated with this Yocto Project release |
76 | </note> | 76 | (version &YOCTO_DOC_VERSION;), |
77 | see the Yocto Project Toaster User Manual from the | ||
78 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. | ||
79 | </para></listitem> | ||
80 | <listitem><para> | ||
81 | This version of the manual is version | ||
82 | &YOCTO_DOC_VERSION;. | ||
83 | For later releases of the Yocto Project (if they exist), | ||
84 | go to the | ||
85 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
86 | and use the drop-down "Active Releases" button | ||
87 | and choose the Yocto Project version for which you want | ||
88 | the manual. | ||
89 | </para></listitem> | ||
90 | <listitem><para> | ||
91 | For an in-development version of the Yocto Project | ||
92 | Toaster User Manual, see | ||
93 | <ulink url='&YOCTO_DOCS_URL;/latest/toaster-manual/toaster-manual.html'></ulink>. | ||
94 | </para></listitem> | ||
95 | </itemizedlist> | ||
96 | </note> | ||
77 | 97 | ||
78 | </legalnotice> | 98 | </legalnotice> |
79 | 99 | ||
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 @@ | |||
20 | <itemizedlist> | 20 | <itemizedlist> |
21 | <listitem><para> | 21 | <listitem><para> |
22 | For the latest version of the Yocto Project Quick | 22 | For the latest version of the Yocto Project Quick |
23 | Start associated with this Yocto Project release, | 23 | Start associated with this Yocto Project release |
24 | (version &YOCTO_DOC_VERSION;), | ||
24 | see the Yocto Project Quick Start from the | 25 | see the Yocto Project Quick Start from the |
25 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>. | 26 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. |
26 | </para></listitem> | 27 | </para></listitem> |
27 | <listitem><para> | 28 | <listitem><para> |
28 | Later releases of the Yocto Project might exist and the | 29 | This version of the manual is version |
29 | associated Yocto Project Quick Start for any later | 30 | &YOCTO_DOC_VERSION;. |
30 | release can be found at | 31 | For later releases of the Yocto Project (if they exist), |
31 | <ulink url='&YOCTO_HOME_URL;/documentation'></ulink>. | 32 | go to the |
33 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
34 | and use the drop-down "Active Releases" button | ||
35 | and choose the Yocto Project version for which you want | ||
36 | the manual. | ||
32 | </para></listitem> | 37 | </para></listitem> |
33 | <listitem><para> | 38 | <listitem><para> |
34 | For an in-development version of the Yocto Project | 39 | For an in-development version of the Yocto Project |