diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-intro.xml | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index a3b837f6f3..b9a63225ab 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml | |||
@@ -1,5 +1,6 @@ | |||
1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
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 | 4 | ||
4 | <chapter id='dev-manual-intro'> | 5 | <chapter id='dev-manual-intro'> |
5 | 6 | ||
@@ -15,7 +16,7 @@ | |||
15 | using the Yocto Project. | 16 | using the Yocto Project. |
16 | Because much of the information in this manual is general, it contains many references to other | 17 | Because much of the information in this manual is general, it contains many references to other |
17 | sources where you can find more detail. | 18 | sources where you can find more detail. |
18 | For example, detailed information on Git, repositories and open-source in general | 19 | For example, detailed information on Git, repositories and open source in general |
19 | can be found in many places. | 20 | can be found in many places. |
20 | Another example is how to get set up to use the Yocto Project, which our Yocto Project Quick Start covers. | 21 | Another example is how to get set up to use the Yocto Project, which our Yocto Project Quick Start covers. |
21 | </para> | 22 | </para> |
@@ -35,10 +36,10 @@ | |||
35 | <itemizedlist> | 36 | <itemizedlist> |
36 | <listitem><para>Information that lets you get set | 37 | <listitem><para>Information that lets you get set |
37 | up to develop using the Yocto Project.</para></listitem> | 38 | up to develop using the Yocto Project.</para></listitem> |
38 | <listitem><para>Information to help developers that are new to the open source environment | 39 | <listitem><para>Information to help developers who are new to the open source environment |
39 | and to the distributed revision control system Git, which the Yocto Project | 40 | and to the distributed revision control system Git, which the Yocto Project |
40 | uses.</para></listitem> | 41 | uses.</para></listitem> |
41 | <listitem><para>An understanding of common end-to-end development models.</para></listitem> | 42 | <listitem><para>An understanding of common end-to-end development models and tasks.</para></listitem> |
42 | <listitem><para>Development case overviews for both system development and user-space | 43 | <listitem><para>Development case overviews for both system development and user-space |
43 | applications.</para></listitem> | 44 | applications.</para></listitem> |
44 | <listitem><para>An overview and understanding of the emulation environment used with | 45 | <listitem><para>An overview and understanding of the emulation environment used with |
@@ -63,13 +64,13 @@ | |||
63 | <itemizedlist> | 64 | <itemizedlist> |
64 | <listitem><para>Step-by-step instructions if those instructions exist in other Yocto | 65 | <listitem><para>Step-by-step instructions if those instructions exist in other Yocto |
65 | Project documentation. | 66 | Project documentation. |
66 | For example, The Application Development Toolkit (ADT) User’s Guide contains detailed | 67 | For example, the Application Development Toolkit (ADT) User’s Guide contains detailed |
67 | instruction on how to obtain and configure the | 68 | instruction on how to obtain and configure the |
68 | <trademark class='trade'>Eclipse</trademark> Yocto Plug-in.</para></listitem> | 69 | <trademark class='trade'>Eclipse</trademark> Yocto Plug-in.</para></listitem> |
69 | <listitem><para>Reference material. | 70 | <listitem><para>Reference material. |
70 | This type of material resides in an appropriate reference manual. | 71 | This type of material resides in an appropriate reference manual. |
71 | For example, system variables are documented in the | 72 | For example, system variables are documented in the |
72 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html'> | 73 | <ulink url='&YOCTO_DOCS_REF_URL;'> |
73 | Yocto Project Reference Manual</ulink>.</para></listitem> | 74 | Yocto Project Reference Manual</ulink>.</para></listitem> |
74 | <listitem><para>Detailed public information that is not specific to the Yocto Project. | 75 | <listitem><para>Detailed public information that is not specific to the Yocto Project. |
75 | For example, exhaustive information on how to use Git is covered better through the | 76 | For example, exhaustive information on how to use Git is covered better through the |
@@ -86,31 +87,31 @@ | |||
86 | need to supplement it with other information. | 87 | need to supplement it with other information. |
87 | The following list presents other sources of information you might find helpful: | 88 | The following list presents other sources of information you might find helpful: |
88 | <itemizedlist> | 89 | <itemizedlist> |
89 | <listitem><para><emphasis>The <ulink url='http://www.yoctoproject.org'>Yocto Project Website</ulink>: | 90 | <listitem><para><emphasis>The <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>: |
90 | </emphasis> The home page for the Yocto Project provides lots of information on the project | 91 | </emphasis> The home page for the Yocto Project provides lots of information on the project |
91 | as well as links to software and documentation.</para></listitem> | 92 | as well as links to software and documentation.</para></listitem> |
92 | <listitem><para><emphasis> | 93 | <listitem><para><emphasis> |
93 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/yocto-project-qs/yocto-project-qs.html'> | 94 | <ulink url='&YOCTO_DOCS_QS_URL;'> |
94 | The Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started | 95 | The Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started |
95 | with the Yocto Project quickly and start building an image.</para></listitem> | 96 | with the Yocto Project quickly and start building an image.</para></listitem> |
96 | <listitem><para><emphasis> | 97 | <listitem><para><emphasis> |
97 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html'> | 98 | <ulink url='&YOCTO_DOCS_REF_URL;'> |
98 | The Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference | 99 | The Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference |
99 | guide to the Yocto Project build component known as "Poky." | 100 | guide to the Yocto Project build component known as "Poky." |
100 | The manual also contains a reference chapter on Board Support Package (BSP) | 101 | The manual also contains a reference chapter on Board Support Package (BSP) |
101 | layout.</para></listitem> | 102 | layout.</para></listitem> |
102 | <listitem><para><emphasis> | 103 | <listitem><para><emphasis> |
103 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/adt-manual/adt-manual.html'> | 104 | <ulink url='&YOCTO_DOCS_ADT_URL;'> |
104 | The Yocto Project Application Development Toolkit (ADT) User's Guide</ulink>:</emphasis> | 105 | The Yocto Project Application Development Toolkit (ADT) User's Guide</ulink>:</emphasis> |
105 | This guide provides information that lets you get going with the ADT to | 106 | This guide provides information that lets you get going with the ADT to |
106 | develop projects using the Yocto Project.</para></listitem> | 107 | develop projects using the Yocto Project.</para></listitem> |
107 | <listitem><para><emphasis> | 108 | <listitem><para><emphasis> |
108 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/bsp-guide/bsp-guide.html'> | 109 | <ulink url='&YOCTO_DOCS_BSP_URL;'> |
109 | The Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis> | 110 | The Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis> |
110 | This guide defines the structure for BSP components. | 111 | This guide defines the structure for BSP components. |
111 | Having a commonly understood structure encourages standardization.</para></listitem> | 112 | Having a commonly understood structure encourages standardization.</para></listitem> |
112 | <listitem><para><emphasis> | 113 | <listitem><para><emphasis> |
113 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/kernel-manual/kernel-manual.html'> | 114 | <ulink url='&YOCTO_DOCS_KERNEL_URL;'> |
114 | The Yocto Project Kernel Architecture and Use Manual</ulink>:</emphasis> | 115 | The Yocto Project Kernel Architecture and Use Manual</ulink>:</emphasis> |
115 | This manual describes the architecture of the Yocto Project kernel and provides | 116 | This manual describes the architecture of the Yocto Project kernel and provides |
116 | some work flow examples.</para></listitem> | 117 | some work flow examples.</para></listitem> |
@@ -120,14 +121,14 @@ | |||
120 | demonstrates how an application developer uses Yocto Plug-in features within | 121 | demonstrates how an application developer uses Yocto Plug-in features within |
121 | the Eclipse IDE.</para></listitem> | 122 | the Eclipse IDE.</para></listitem> |
122 | <listitem><para><emphasis> | 123 | <listitem><para><emphasis> |
123 | <ulink url='http://wiki.yoctoproject.org/wiki/FAQ'>FAQ</ulink>:</emphasis> | 124 | <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis> |
124 | A list of commonly asked questions and their answers.</para></listitem> | 125 | A list of commonly asked questions and their answers.</para></listitem> |
125 | <listitem><para><emphasis> | 126 | <listitem><para><emphasis> |
126 | <ulink url='http://www.yoctoproject.org/download/yocto/yocto-project-1.0-release-notes-poky-5.0'> | 127 | <ulink url='&YOCTO_HOME_URL;/download/yocto/yocto-project-1.1.2-release-notes-poky-&POKYVERSION;'> |
127 | Release Notes</ulink>:</emphasis> Features, updates and known issues for the current | 128 | Release Notes</ulink>:</emphasis> Features, updates and known issues for the current |
128 | release of the Yocto Project.</para></listitem> | 129 | release of the Yocto Project.</para></listitem> |
129 | <listitem><para><emphasis> | 130 | <listitem><para><emphasis> |
130 | <ulink url='http://bugzilla.yoctoproject.org/'>Bugzilla</ulink>:</emphasis> | 131 | <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis> |
131 | The bug tracking application the Yocto Project uses. | 132 | The bug tracking application the Yocto Project uses. |
132 | If you find problems with the Yocto Project, you should report them using this | 133 | If you find problems with the Yocto Project, you should report them using this |
133 | application.</para></listitem> | 134 | application.</para></listitem> |
@@ -135,11 +136,11 @@ | |||
135 | Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing | 136 | Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing |
136 | lists, click on the following URLs and follow the instructions: | 137 | lists, click on the following URLs and follow the instructions: |
137 | <itemizedlist> | 138 | <itemizedlist> |
138 | <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/yocto'></ulink> for a | 139 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a |
139 | Yocto Project Discussions mailing list.</para></listitem> | 140 | Yocto Project Discussions mailing list.</para></listitem> |
140 | <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/poky'></ulink> for a | 141 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a |
141 | Yocto Project Discussions mailing list about the Poky build system.</para></listitem> | 142 | Yocto Project Discussions mailing list about the Poky build system.</para></listitem> |
142 | <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/yocto-announce'></ulink> | 143 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> |
143 | for a mailing list to receive offical Yocto Project announcements for developments and | 144 | for a mailing list to receive offical Yocto Project announcements for developments and |
144 | as well as Yocto Project milestones.</para></listitem> | 145 | as well as Yocto Project milestones.</para></listitem> |
145 | </itemizedlist></para></listitem> | 146 | </itemizedlist></para></listitem> |
@@ -148,20 +149,20 @@ | |||
148 | for Yocto Project and Poky discussions: <filename>#yocto</filename> and | 149 | for Yocto Project and Poky discussions: <filename>#yocto</filename> and |
149 | <filename>#poky</filename>.</para></listitem> | 150 | <filename>#poky</filename>.</para></listitem> |
150 | <listitem><para><emphasis> | 151 | <listitem><para><emphasis> |
151 | <ulink url='http://www.openedhand.com/'>OpenedHand</ulink>:</emphasis> | 152 | <ulink url='&OH_HOME_URL;'>OpenedHand</ulink>:</emphasis> |
152 | The company where the Yocto Project build system Poky was first developed. | 153 | The company where the Yocto Project build system Poky was first developed. |
153 | OpenedHand has since been acquired by Intel Corporation.</para></listitem> | 154 | OpenedHand has since been acquired by Intel Corporation.</para></listitem> |
154 | <listitem><para><emphasis> | 155 | <listitem><para><emphasis> |
155 | <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis> | 156 | <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis> |
156 | The company who acquired OpenedHand in 2008 and continues development on the | 157 | The company that acquired OpenedHand in 2008 and continues development on the |
157 | Yocto Project.</para></listitem> | 158 | Yocto Project.</para></listitem> |
158 | <listitem><para><emphasis> | 159 | <listitem><para><emphasis> |
159 | <ulink url='http://www.openembedded.org/'>OpenEmbedded</ulink>:</emphasis> | 160 | <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis> |
160 | The upstream, generic, embedded distribution the Yocto Project build system (Poky) derives | 161 | The upstream, generic, embedded distribution the Yocto Project build system (Poky) derives |
161 | from and to which it contributes.</para></listitem> | 162 | from and to which it contributes.</para></listitem> |
162 | <listitem><para><emphasis> | 163 | <listitem><para><emphasis> |
163 | <ulink url='http://developer.berlios.de/projects/bitbake/'> | 164 | <ulink url='http://developer.berlios.de/projects/bitbake/'> |
164 | Bitbake</ulink>:</emphasis> The tool used to process Yocto Project metadata.</para></listitem> | 165 | BitBake</ulink>:</emphasis> The tool used to process Yocto Project metadata.</para></listitem> |
165 | <listitem><para><emphasis> | 166 | <listitem><para><emphasis> |
166 | <ulink url='http://bitbake.berlios.de/manual/'> | 167 | <ulink url='http://bitbake.berlios.de/manual/'> |
167 | BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool. | 168 | BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool. |