diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-11-10 10:28:25 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-11-25 15:24:17 +0000 |
commit | 684c35b7aa0898f95ab70a5982ef74ce98107d93 (patch) | |
tree | 7c6cb2ead87d121c32ed9d21943a28b54a0bb35d /documentation/kernel-manual | |
parent | 8632404294eaa3464797cffc757add6b5d92b7dc (diff) | |
download | poky-684c35b7aa0898f95ab70a5982ef74ce98107d93.tar.gz |
documentation: Changed all manual links to point to "latest"
There are many references to YP documentation throughout the
YP manual set. They used to have hard-coded links to the
current release (e.g. yoctoproject.org/docs/1.1 for Edison).
This created a situation where if you went to a document on
the website and clicked on a external reference to another
manual, you would redirect to the current manual on the website.
Really, you would want to go to the latest manual, which is
one that is under development. Changing the links to
"yoctoproject.org/docs/latest" makes the tip of master, which
is used for devloping the next release, always have references
to the manuals being developed and not back to the stable
released set of manuals.
This "latest" and "current" scheme for the links is not perfect.
What has to happen when the latest set of the manuals freezes
and becomes the next stable release, all the links in the docs
will need to be changed from "latest" in the URL to the new
release number. So for example, all the "latest" occurences
would need to be changed to "1.2". Then for the next cycle
as development begins again, the links need to be infused with
"latest" again.
(From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-manual')
-rw-r--r-- | documentation/kernel-manual/kernel-concepts.xml | 8 | ||||
-rw-r--r-- | documentation/kernel-manual/kernel-doc-intro.xml | 8 | ||||
-rw-r--r-- | documentation/kernel-manual/kernel-how-to.xml | 22 | ||||
-rw-r--r-- | documentation/kernel-manual/kernel-manual.xml | 2 |
4 files changed, 20 insertions, 20 deletions
diff --git a/documentation/kernel-manual/kernel-concepts.xml b/documentation/kernel-manual/kernel-concepts.xml index bcda78c4e1..2fef32aee5 100644 --- a/documentation/kernel-manual/kernel-concepts.xml +++ b/documentation/kernel-manual/kernel-concepts.xml | |||
@@ -159,8 +159,8 @@ | |||
159 | The features are tagged and organized by way of a branching strategy implemented by the | 159 | The features are tagged and organized by way of a branching strategy implemented by the |
160 | source code manager (SCM) Git. | 160 | source code manager (SCM) Git. |
161 | For information on Git as applied to the Yocto Project, see the | 161 | For information on Git as applied to the Yocto Project, see the |
162 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#git'>Git</ulink>" | 162 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#git'>Git</ulink>" |
163 | section in <ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html'>The | 163 | section in <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The |
164 | Yocto Project Development Manual</ulink>. | 164 | Yocto Project Development Manual</ulink>. |
165 | </para> | 165 | </para> |
166 | <para> | 166 | <para> |
@@ -288,8 +288,8 @@ | |||
288 | <para> | 288 | <para> |
289 | You can find documentation on Git at <ulink url='http://git-scm.com/documentation'></ulink>. | 289 | You can find documentation on Git at <ulink url='http://git-scm.com/documentation'></ulink>. |
290 | You can also get an introduction to Git as it applies to the Yocto Project in the | 290 | You can also get an introduction to Git as it applies to the Yocto Project in the |
291 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#git'>Git</ulink>" | 291 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#git'>Git</ulink>" |
292 | section in <ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html'>The | 292 | section in <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The |
293 | Yocto Project Development Manual</ulink>. | 293 | Yocto Project Development Manual</ulink>. |
294 | This section overviews Git and describes a minimal set of commands that allow you to be | 294 | This section overviews Git and describes a minimal set of commands that allow you to be |
295 | functional using Git. | 295 | functional using Git. |
diff --git a/documentation/kernel-manual/kernel-doc-intro.xml b/documentation/kernel-manual/kernel-doc-intro.xml index a9e51725da..37f1dfebb1 100644 --- a/documentation/kernel-manual/kernel-doc-intro.xml +++ b/documentation/kernel-manual/kernel-doc-intro.xml | |||
@@ -45,10 +45,10 @@ | |||
45 | 45 | ||
46 | <para> | 46 | <para> |
47 | For more discussion on the Yocto Project kernel, you can also see the | 47 | For more discussion on the Yocto Project kernel, you can also see the |
48 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#kernel-overview'>Kernel Overview</ulink>", | 48 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#kernel-overview'>Kernel Overview</ulink>", |
49 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#kernel-modification-workflow'>Kernel Modification Workflow</ulink>", and | 49 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#kernel-modification-workflow'>Kernel Modification Workflow</ulink>", and |
50 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#dev-manual-kernel-appendix'>Kernel Modification Example</ulink>" sections all in | 50 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#dev-manual-kernel-appendix'>Kernel Modification Example</ulink>" sections all in |
51 | <ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html'>The Yocto Project Development Manual</ulink>. | 51 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The Yocto Project Development Manual</ulink>. |
52 | </para> | 52 | </para> |
53 | 53 | ||
54 | <para> | 54 | <para> |
diff --git a/documentation/kernel-manual/kernel-how-to.xml b/documentation/kernel-manual/kernel-how-to.xml index df8605ed6f..756758d8a3 100644 --- a/documentation/kernel-manual/kernel-how-to.xml +++ b/documentation/kernel-manual/kernel-how-to.xml | |||
@@ -50,8 +50,8 @@ | |||
50 | </literallayout> | 50 | </literallayout> |
51 | For another example of how to set up a local Git repository of the Linux Yocto | 51 | For another example of how to set up a local Git repository of the Linux Yocto |
52 | kernel files, see the | 52 | kernel files, see the |
53 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#local-kernel-files'>Linux Yocto Kernel</ulink>" bulleted item in | 53 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#local-kernel-files'>Linux Yocto Kernel</ulink>" bulleted item in |
54 | <ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html'>The Yocto Project Development Manual</ulink>. | 54 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The Yocto Project Development Manual</ulink>. |
55 | </para> | 55 | </para> |
56 | <para> | 56 | <para> |
57 | Once the Git repository is set up on your local machine, you can switch to the | 57 | Once the Git repository is set up on your local machine, you can switch to the |
@@ -226,9 +226,9 @@ | |||
226 | You can find Git documentation at | 226 | You can find Git documentation at |
227 | <ulink url='http://git-scm.com/documentation'></ulink>. | 227 | <ulink url='http://git-scm.com/documentation'></ulink>. |
228 | You can find a simple overview of using Git with the Yocto Project in the | 228 | You can find a simple overview of using Git with the Yocto Project in the |
229 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#git'>Git</ulink>" | 229 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#git'>Git</ulink>" |
230 | section of | 230 | section of |
231 | <ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html'>The Yocto | 231 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The Yocto |
232 | Project Development Manual</ulink>. | 232 | Project Development Manual</ulink>. |
233 | </para> | 233 | </para> |
234 | 234 | ||
@@ -354,9 +354,9 @@ | |||
354 | The Yocto Project provides scripts that help you work in a collaborative development | 354 | The Yocto Project provides scripts that help you work in a collaborative development |
355 | environment. | 355 | environment. |
356 | For information on these scripts, see the | 356 | For information on these scripts, see the |
357 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#pushing-a-change-upstream'>Pushing a Change Upstream and Requesting a Pull</ulink>" and | 357 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#pushing-a-change-upstream'>Pushing a Change Upstream and Requesting a Pull</ulink>" and |
358 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#submitting-a-patch'>Submitting a Patch Through Email</ulink>" sections in | 358 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#submitting-a-patch'>Submitting a Patch Through Email</ulink>" sections in |
359 | <ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html'>The | 359 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The |
360 | Yocto Project Development Manual</ulink>". | 360 | Yocto Project Development Manual</ulink>". |
361 | </para> | 361 | </para> |
362 | 362 | ||
@@ -637,8 +637,8 @@ | |||
637 | The messages used to commit changes are a large part of these standards. | 637 | The messages used to commit changes are a large part of these standards. |
638 | Consequently, be sure that the headers for each commit have the required information. | 638 | Consequently, be sure that the headers for each commit have the required information. |
639 | For information on how to follow the Yocto Project commit message standards, see the | 639 | For information on how to follow the Yocto Project commit message standards, see the |
640 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#how-to-submit-a-change'>How to Submit a Change</ulink>" section in | 640 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#how-to-submit-a-change'>How to Submit a Change</ulink>" section in |
641 | <ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html'>The | 641 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The |
642 | Yocto Project Development Manual</ulink>". | 642 | Yocto Project Development Manual</ulink>". |
643 | </para> | 643 | </para> |
644 | 644 | ||
@@ -772,8 +772,8 @@ | |||
772 | existing similar BSP. | 772 | existing similar BSP. |
773 | The information is introductory in nature and does not provide step-by-step examples. | 773 | The information is introductory in nature and does not provide step-by-step examples. |
774 | For detailed information on how to create a BSP given an existing similar BSP, see | 774 | For detailed information on how to create a BSP given an existing similar BSP, see |
775 | the "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#dev-manual-bsp-appendix'>BSP Development Example</ulink>" appendix in | 775 | the "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#dev-manual-bsp-appendix'>BSP Development Example</ulink>" appendix in |
776 | <ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html'>The | 776 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The |
777 | Yocto Project Development Manual</ulink>, or see the | 777 | Yocto Project Development Manual</ulink>, or see the |
778 | <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'>Transcript:_creating_one_generic_Atom_BSP_from_another</ulink> | 778 | <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'>Transcript:_creating_one_generic_Atom_BSP_from_another</ulink> |
779 | wiki page. | 779 | wiki page. |
diff --git a/documentation/kernel-manual/kernel-manual.xml b/documentation/kernel-manual/kernel-manual.xml index 214892f19c..abf8d00091 100644 --- a/documentation/kernel-manual/kernel-manual.xml +++ b/documentation/kernel-manual/kernel-manual.xml | |||
@@ -63,7 +63,7 @@ | |||
63 | <note> | 63 | <note> |
64 | Due to production processes, there could be differences between the Yocto Project | 64 | Due to production processes, there could be differences between the Yocto Project |
65 | documentation bundled in the release tarball and | 65 | documentation bundled in the release tarball and |
66 | <ulink url='http://www.yoctoproject.org/docs/1.1/kernel-manual/kernel-manual.html'> | 66 | <ulink url='http://www.yoctoproject.org/docs/latest/kernel-manual/kernel-manual.html'> |
67 | The Yocto Project Kernel Architecture and Use Manual</ulink> on | 67 | The Yocto Project Kernel Architecture and Use Manual</ulink> on |
68 | the <ulink url='http://www.yoctoproject.org'>Yocto Project</ulink> website. | 68 | the <ulink url='http://www.yoctoproject.org'>Yocto Project</ulink> website. |
69 | For the latest version of this manual, see the manual on the website. | 69 | For the latest version of this manual, see the manual on the website. |