dev-manual, ref-manual: Reorganized "Other Information"

Fixes [YOCTO #11630] The exhaustive list of useful links and references to other YP documentation existed in the dev-manual. This is not the correct place for this type of reference information. I have moved that list to the ref-manual where it should be. The dev-manual now simply provides a link into that section. (From yocto-docs rev: eeceb597988134ced85aab4b9ddaeed923f17b03) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
author: Scott Rifenbark <srifenbark@gmail.com> 2017-06-13 10:10:51 -0700
committer: Richard Purdie <richard.purdie@linuxfoundation.org> 2017-06-14 10:19:25 +0100
commit: ed0ecc7b76698707529dcc3a765c037b7976de93 (patch)
tree: f46d071118145312237c6f7cc88deb1480fdf8a3 /documentation/dev-manual/dev-manual-intro.xml
parent: 741dddf11ae899eec6ed710daf005551f304563b (diff)
download: poky-ed0ecc7b76698707529dcc3a765c037b7976de93.tar.gz
1 files changed, 5 insertions, 136 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml
index 49148abead..020f9373e6 100644
--- a/documentation/dev-manual/dev-manual-intro.xml
+++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -109,144 +109,13 @@
        <title>Other Information</title>
        <para>
-            Because this manual presents overview information for many different
+            Because this manual presents information for many different
            topics, supplemental information is recommended for full
            comprehension.
-            The following list presents other sources of information you might find helpful:
+            See the
-            <itemizedlist>
+            "<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>"
-                <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:
+            section in the Yocto Project Reference Manual for helpful
-                    </emphasis> The home page for the Yocto Project provides lots of information on the project
+            sources.
-                    as well as links to software and documentation.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis>
-                    This short document lets you get started
-                    with the Yocto Project and quickly begin building an image.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis>
-                    This manual is a reference
-                    guide to the OpenEmbedded build system, which is based on BitBake.
-                    The build system is sometimes referred to as "Poky".
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>:</emphasis>
-                    This guide provides information that lets you get going
-                    with the standard or extensible SDK.
-                    An SDK, with its cross-development toolchains, allows you
-                    to develop projects inside or outside of the Yocto Project
-                    environment.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis>
-                    This guide defines the structure for BSP components.
-                    Having a commonly understood structure encourages standardization.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:</emphasis>
-                    This manual describes how to work with Linux Yocto kernels as well as provides a bit
-                    of conceptual information on the construction of the Yocto Linux kernel tree.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>:</emphasis>
-                    This manual presents a set of common and generally useful tracing and
-                    profiling schemes along with their applications (as appropriate) to each tool.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>:</emphasis>
-                    This manual introduces and describes how to set up and use
-                    Toaster, which is a web interface to the Yocto Project's
-                    <link linkend='build-system-term'>OpenEmbedded Build System</link>.
-                    </para></listitem>
-<!--
-                <listitem><para><emphasis>
-                    <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'>
-                    Eclipse IDE Yocto Plug-in</ulink>:</emphasis>
-                    A step-by-step instructional video that
-                    demonstrates how an application developer uses Yocto Plug-in features within
-                    the Eclipse IDE.
-                    </para></listitem>
-->
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-appendix-latest-yp-eclipse-plug-in'>Eclipse IDE Yocto Plug-in</ulink>:</emphasis>
-                    Instructions that demonstrate how an application developer
-                    uses the Eclipse Yocto Project Plug-in feature within
-                    the Eclipse IDE.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis>
-                    A list of commonly asked questions and their answers.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:</emphasis>
-                    Features, updates and known issues for the current
-                    release of the Yocto Project.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/toaster'>Toaster</ulink>:</emphasis>
-                    An Application Programming Interface (API) and web-based
-                    interface to the OpenEmbedded build system, which uses
-                    BitBake, that reports build information.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/build-appliance'>Build Appliance</ulink>:</emphasis>
-                    A virtual machine that
-                    enables you to build and boot a custom embedded Linux image
-                    with the Yocto Project using a non-Linux development system.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis>
-                    The bug tracking application the Yocto Project uses.
-                    If you find problems with the Yocto Project, you should report them using this
-                    application.
-                    </para></listitem>
-                <listitem><para><emphasis>Yocto Project Mailing Lists:</emphasis>
-                    To subscribe to the Yocto Project mailing
-                    lists, click on the following URLs and follow the instructions:
-                    <itemizedlist>
-                        <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink>
-                            for a Yocto Project Discussions mailing list.
-                            </para></listitem>
-                        <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink>
-                            for a Yocto Project Discussions mailing list about the
-                            OpenEmbedded build system (Poky).
-                            </para></listitem>
-                        <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>
-                            for a mailing list to receive official Yocto Project announcements
-                            as well as Yocto Project milestones.
-                            </para></listitem>
-                        <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink>
-                            for a listing of all public mailing lists on
-                            <filename>lists.yoctoproject.org</filename>.
-                            </para></listitem>
-                    </itemizedlist></para></listitem>
-                <listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis>
-                    Two IRC channels on freenode are available
-                    for Yocto Project and Poky discussions: <filename>#yocto</filename> and
-                    <filename>#poky</filename>, respectively.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
-                    The build system used by the Yocto Project.
-                    This project is the upstream, generic, embedded distribution
-                    from which the Yocto Project derives its build system (Poky)
-                    and to which it contributes.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='http://www.openembedded.org/wiki/BitBake'>BitBake</ulink>:</emphasis>
-                    The tool used by the OpenEmbedded build system
-                    to process project metadata.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual:</ulink></emphasis>
-                    A comprehensive guide to the BitBake tool.
-                    If you want information on BitBake, see this manual.
-                    </para></listitem>
-                <listitem><para><emphasis>
-                    <ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>:</emphasis>
-                    An open-source machine emulator and virtualizer.
-                    </para></listitem>
-            </itemizedlist>
        </para>
    </section>
 </chapter>
author	Scott Rifenbark <srifenbark@gmail.com>	2017-06-13 10:10:51 -0700
committer	Richard Purdie <richard.purdie@linuxfoundation.org>	2017-06-14 10:19:25 +0100
commit	ed0ecc7b76698707529dcc3a765c037b7976de93 (patch)
tree	f46d071118145312237c6f7cc88deb1480fdf8a3 /documentation/dev-manual/dev-manual-intro.xml
parent	741dddf11ae899eec6ed710daf005551f304563b (diff)
download	poky-ed0ecc7b76698707529dcc3a765c037b7976de93.tar.gz

diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index 49148abead..020f9373e6 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -109,144 +109,13 @@
109	<title>Other Information</title>	109	<title>Other Information</title>
110		110
111	<para>	111	<para>
112	Because this manual presents overview information for many different	112	Because this manual presents information for many different
113	topics, supplemental information is recommended for full	113	topics, supplemental information is recommended for full
114	comprehension.	114	comprehension.
115	The following list presents other sources of information you might find helpful:	115	See the
116	<itemizedlist>	116	"<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>"
117	<listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:	117	section in the Yocto Project Reference Manual for helpful
118	</emphasis> The home page for the Yocto Project provides lots of information on the project	118	sources.
119	as well as links to software and documentation.
120	</para></listitem>
121	<listitem><para><emphasis>
122	<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis>
123	This short document lets you get started
124	with the Yocto Project and quickly begin building an image.
125	</para></listitem>
126	<listitem><para><emphasis>
127	<ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis>
128	This manual is a reference
129	guide to the OpenEmbedded build system, which is based on BitBake.
130	The build system is sometimes referred to as "Poky".
131	</para></listitem>
132	<listitem><para><emphasis>
133	<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>:</emphasis>
134	This guide provides information that lets you get going
135	with the standard or extensible SDK.
136	An SDK, with its cross-development toolchains, allows you
137	to develop projects inside or outside of the Yocto Project
138	environment.
139	</para></listitem>
140	<listitem><para><emphasis>
141	<ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis>
142	This guide defines the structure for BSP components.
143	Having a commonly understood structure encourages standardization.
144	</para></listitem>
145	<listitem><para><emphasis>
146	<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:</emphasis>
147	This manual describes how to work with Linux Yocto kernels as well as provides a bit
148	of conceptual information on the construction of the Yocto Linux kernel tree.
149	</para></listitem>
150	<listitem><para><emphasis>
151	<ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>:</emphasis>
152	This manual presents a set of common and generally useful tracing and
153	profiling schemes along with their applications (as appropriate) to each tool.
154	</para></listitem>
155	<listitem><para><emphasis>
156	<ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>:</emphasis>
157	This manual introduces and describes how to set up and use
158	Toaster, which is a web interface to the Yocto Project's
159	<link linkend='build-system-term'>OpenEmbedded Build System</link>.
160	</para></listitem>
161	<!--
162	<listitem><para><emphasis>
163	<ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'>
164	Eclipse IDE Yocto Plug-in</ulink>:</emphasis>
165	A step-by-step instructional video that
166	demonstrates how an application developer uses Yocto Plug-in features within
167	the Eclipse IDE.
168	</para></listitem>
169	-->
170	<listitem><para><emphasis>
171	<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-appendix-latest-yp-eclipse-plug-in'>Eclipse IDE Yocto Plug-in</ulink>:</emphasis>
172	Instructions that demonstrate how an application developer
173	uses the Eclipse Yocto Project Plug-in feature within
174	the Eclipse IDE.
175	</para></listitem>
176	<listitem><para><emphasis>
177	<ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis>
178	A list of commonly asked questions and their answers.
179	</para></listitem>
180	<listitem><para><emphasis>
181	<ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:</emphasis>
182	Features, updates and known issues for the current
183	release of the Yocto Project.
184	</para></listitem>
185	<listitem><para><emphasis>
186	<ulink url='&YOCTO_HOME_URL;/tools-resources/projects/toaster'>Toaster</ulink>:</emphasis>
187	An Application Programming Interface (API) and web-based
188	interface to the OpenEmbedded build system, which uses
189	BitBake, that reports build information.
190	</para></listitem>
191	<listitem><para><emphasis>
192	<ulink url='&YOCTO_HOME_URL;/tools-resources/projects/build-appliance'>Build Appliance</ulink>:</emphasis>
193	A virtual machine that
194	enables you to build and boot a custom embedded Linux image
195	with the Yocto Project using a non-Linux development system.
196	</para></listitem>
197	<listitem><para><emphasis>
198	<ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis>
199	The bug tracking application the Yocto Project uses.
200	If you find problems with the Yocto Project, you should report them using this
201	application.
202	</para></listitem>
203	<listitem><para><emphasis>Yocto Project Mailing Lists:</emphasis>
204	To subscribe to the Yocto Project mailing
205	lists, click on the following URLs and follow the instructions:
206	<itemizedlist>
207	<listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink>
208	for a Yocto Project Discussions mailing list.
209	</para></listitem>
210	<listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink>
211	for a Yocto Project Discussions mailing list about the
212	OpenEmbedded build system (Poky).
213	</para></listitem>
214	<listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>
215	for a mailing list to receive official Yocto Project announcements
216	as well as Yocto Project milestones.
217	</para></listitem>
218	<listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink>
219	for a listing of all public mailing lists on
220	<filename>lists.yoctoproject.org</filename>.
221	</para></listitem>
222	</itemizedlist></para></listitem>
223	<listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis>
224	Two IRC channels on freenode are available
225	for Yocto Project and Poky discussions: <filename>#yocto</filename> and
226	<filename>#poky</filename>, respectively.
227	</para></listitem>
228	<listitem><para><emphasis>
229	<ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
230	The build system used by the Yocto Project.
231	This project is the upstream, generic, embedded distribution
232	from which the Yocto Project derives its build system (Poky)
233	and to which it contributes.
234	</para></listitem>
235	<listitem><para><emphasis>
236	<ulink url='http://www.openembedded.org/wiki/BitBake'>BitBake</ulink>:</emphasis>
237	The tool used by the OpenEmbedded build system
238	to process project metadata.
239	</para></listitem>
240	<listitem><para><emphasis>
241	<ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual:</ulink></emphasis>
242	A comprehensive guide to the BitBake tool.
243	If you want information on BitBake, see this manual.
244	</para></listitem>
245	<listitem><para><emphasis>
246	<ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>:</emphasis>
247	An open-source machine emulator and virtualizer.
248	</para></listitem>
249	</itemizedlist>
250	</para>	119	</para>
251	</section>	120	</section>
252	</chapter>	121	</chapter>