diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2017-06-14 09:50:55 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-06-22 09:16:43 +0100 |
commit | de6d45fefc3000ee8918d7c18448758d4216bae5 (patch) | |
tree | d0e7f2913f00d7df940dad84075dd9937e0de635 /documentation | |
parent | 3f6a9af9272cf30d78aa3de76af3f6ee0dc2bd22 (diff) | |
download | poky-de6d45fefc3000ee8918d7c18448758d4216bae5.tar.gz |
documentation: Re-org for "closer-look" chapter
Fixes [YOCTO #11630]
The ref-manual needs expansion for the old "closer-look" chapter.
This chapter previously held a detailed look at what happens when
a user uses the YP to develop something. Now, the chapter needs
to also contain YP development environment concepts (e.g. open-
source philosophy, etc.), which are coming from the dev-manual.
Because of this, I renamed the "closer-look.xml" chapter to be
"ref-development-environment.xml". I also renamed the larger
section that was formerly the entire chapter into its own section
named "Development Concepts".
Both these changes caused a few links to break. I fixed all the
links from within the various manuals so they would find appropriate
targets.
I did some re-writing for introductory material to introduce the new
chapter and the section on "Development Concepts".
A new file ("ref-development-environment.xml") was added by basically
renaming the "closer-look.xml" chapter. And, the tracking for
"closer-look.xml" was deleted.
(From yocto-docs rev: e37806474578b4f0ed137f64d68a39a17ab60644)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 4 | ||||
-rw-r--r-- | documentation/ref-manual/ref-development-environment.xml (renamed from documentation/ref-manual/closer-look.xml) | 26 | ||||
-rw-r--r-- | documentation/ref-manual/ref-manual.xml | 2 | ||||
-rw-r--r-- | documentation/ref-manual/technical-details.xml | 4 | ||||
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 2 |
5 files changed, 23 insertions, 15 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 8f39d19044..0a9c1800e3 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -2083,8 +2083,8 @@ | |||
2083 | </para> | 2083 | </para> |
2084 | 2084 | ||
2085 | <para> | 2085 | <para> |
2086 | You can find more information about the build process in the | 2086 | You can find more information about the build process in |
2087 | "<ulink url='&YOCTO_DOCS_REF_URL;#closer-look'>A Closer Look at the Yocto Project Development Environment</ulink>" | 2087 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-development-environment'>The Yocto Project Development Environment</ulink>" |
2088 | chapter of the Yocto Project Reference Manual. | 2088 | chapter of the Yocto Project Reference Manual. |
2089 | </para> | 2089 | </para> |
2090 | </section> | 2090 | </section> |
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/ref-development-environment.xml index 5046465fba..a30cefc391 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/ref-development-environment.xml | |||
@@ -2,18 +2,26 @@ | |||
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > |
4 | 4 | ||
5 | <chapter id='closer-look'> | 5 | <chapter id='ref-development-environment'> |
6 | <title>A Closer Look at the Yocto Project Development Environment</title> | 6 | <title>The Yocto Project Development Environment</title> |
7 | 7 | ||
8 | <para> | 8 | <para> |
9 | This chapter takes a more detailed look at the Yocto Project | 9 | This chapter takes a look at the Yocto Project development |
10 | development environment. | 10 | environment and also provides a detailed look at what goes on during |
11 | The following diagram represents the development environment at a | 11 | development in that environment. |
12 | high level. | 12 | </para> |
13 | |||
14 | <section id="development-concepts"> | ||
15 | <title>Development Concepts</title> | ||
16 | |||
17 | <para> | ||
18 | This section takes a more detailed look inside the development | ||
19 | process. | ||
20 | The following diagram represents development at a high level. | ||
13 | The remainder of this chapter expands on the fundamental input, output, | 21 | The remainder of this chapter expands on the fundamental input, output, |
14 | process, and | 22 | process, and |
15 | <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>) blocks | 23 | <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>) blocks |
16 | in the Yocto Project development environment. | 24 | that make up development in the Yocto Project environment. |
17 | </para> | 25 | </para> |
18 | 26 | ||
19 | <para id='general-yocto-environment-figure'> | 27 | <para id='general-yocto-environment-figure'> |
@@ -21,8 +29,7 @@ | |||
21 | </para> | 29 | </para> |
22 | 30 | ||
23 | <para> | 31 | <para> |
24 | The generalized Yocto Project Development Environment consists of | 32 | In general, development consists of several functional areas: |
25 | several functional areas: | ||
26 | <itemizedlist> | 33 | <itemizedlist> |
27 | <listitem><para><emphasis>User Configuration:</emphasis> | 34 | <listitem><para><emphasis>User Configuration:</emphasis> |
28 | Metadata you can use to control the build process. | 35 | Metadata you can use to control the build process. |
@@ -1620,6 +1627,7 @@ | |||
1620 | </itemizedlist> | 1627 | </itemizedlist> |
1621 | </para> | 1628 | </para> |
1622 | </section> | 1629 | </section> |
1630 | </section> | ||
1623 | 1631 | ||
1624 | </chapter> | 1632 | </chapter> |
1625 | <!-- | 1633 | <!-- |
diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml index 16900adfb8..8096871c1c 100644 --- a/documentation/ref-manual/ref-manual.xml +++ b/documentation/ref-manual/ref-manual.xml | |||
@@ -163,7 +163,7 @@ | |||
163 | 163 | ||
164 | <xi:include href="usingpoky.xml"/> | 164 | <xi:include href="usingpoky.xml"/> |
165 | 165 | ||
166 | <xi:include href="closer-look.xml"/> | 166 | <xi:include href="ref-development-environment.xml"/> |
167 | 167 | ||
168 | <xi:include href="technical-details.xml"/> | 168 | <xi:include href="technical-details.xml"/> |
169 | 169 | ||
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 768f70186b..7fc2e184e6 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml | |||
@@ -55,8 +55,8 @@ | |||
55 | Following are some brief details on these core components. | 55 | Following are some brief details on these core components. |
56 | For additional information on how these components interact during | 56 | For additional information on how these components interact during |
57 | a build, see the | 57 | a build, see the |
58 | "<link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>" | 58 | "<link linkend='development-concepts'>Development Concepts</link>" |
59 | Chapter. | 59 | section. |
60 | </para> | 60 | </para> |
61 | 61 | ||
62 | <section id='usingpoky-components-bitbake'> | 62 | <section id='usingpoky-components-bitbake'> |
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 1d9bd9f2e8..527fcd86cc 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
@@ -948,7 +948,7 @@ | |||
948 | You can get | 948 | You can get |
949 | <ulink url='&YOCTO_DOCS_REF_URL;#usingpoky'>build details</ulink>, | 949 | <ulink url='&YOCTO_DOCS_REF_URL;#usingpoky'>build details</ulink>, |
950 | a | 950 | a |
951 | <ulink url='&YOCTO_DOCS_REF_URL;#closer-look'>closer look</ulink> | 951 | <ulink url='&YOCTO_DOCS_REF_URL;#development-concepts'>closer look</ulink> |
952 | at how the pieces of the Yocto Project development | 952 | at how the pieces of the Yocto Project development |
953 | environment work together, information on various | 953 | environment work together, information on various |
954 | <ulink url='&YOCTO_DOCS_REF_URL;#technical-details'>technical details</ulink>, | 954 | <ulink url='&YOCTO_DOCS_REF_URL;#technical-details'>technical details</ulink>, |