Blame - yocto-poky/documentation/dev-manual/dev-manual-intro.xml - mdmillerii/openbmc

Patrick Williams

c124f4f

2015-09-15 14:41:29 -0500

[diff] [blame]

1

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

2

"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"

3

[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >

<title>The Yocto Project Development Manual</title>

8

9

<title>Introduction</title>

10

11

<para>

12

Welcome to the Yocto Project Development Manual!

13

This manual provides information on how to use the Yocto Project to

14

develop embedded Linux images and user-space applications that

15

run on targeted devices.

16

The manual provides an overview of image, kernel, and

17

user-space application development using the Yocto Project.

18

Because much of the information in this manual is general, it

19

contains many references to other sources where you can find more

20

detail.

21

For example, you can find detailed information on Git, repositories,

22

and open source in general in many places on the Internet.

23

Another example specific to the Yocto Project is how to quickly

24

set up your host development system and build an image, which you

25

find in the

26

<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.

</para>

<para>

The Yocto Project Development Manual does, however, provide

31

guidance and examples on how to change the kernel source code,

32

reconfigure the kernel, and develop an application using the

33

popular <trademark class='trade'>Eclipse</trademark> IDE.

</para>

<note>

By default, using the Yocto Project creates a Poky distribution.

38

However, you can create your own distribution by providing key

39

40

A good example is Angstrom, which has had a distribution

41

based on the Yocto Project since its inception.

42

Other examples include commercial distributions like

43

<ulink url='https://www.yoctoproject.org/organization/wind-river-systems'>Wind River Linux</ulink>,

44

<ulink url='https://www.yoctoproject.org/organization/mentor-graphics'>Mentor Embedded Linux</ulink>,

45

<ulink url='https://www.yoctoproject.org/organization/enea-ab'>ENEA Linux</ulink>

46

and <ulink url='https://www.yoctoproject.org/ecosystem/member-organizations'>others</ulink>.

47

See the "<link linkend='creating-your-own-distribution'>Creating Your Own Distribution</link>"

48

section for more information.

</note>

</section>

<title>What This Manual Provides</title>

54

55

<para>

56

The following list describes what you can get from this manual:

57

58

<listitem><para>Information that lets you get set

59

up to develop using the Yocto Project.</para></listitem>

60

<listitem><para>Information to help developers who are new to

61

the open source environment and to the distributed revision

62

control system Git, which the Yocto Project uses.

63

</para></listitem>

64

<listitem><para>An understanding of common end-to-end

65

development models and tasks.</para></listitem>

66

<listitem><para>Information about common development tasks

67

generally used during image development for

68

embedded devices.

69

</para></listitem>

70

<listitem><para>Information on using the Yocto Project

71

integration of the QuickEMUlator (QEMU), which lets you

72

simulate running on hardware an image you have built using

73

the OpenEmbedded build system.

74

</para></listitem>

75

<listitem><para>Many references to other sources of related

76

information.</para></listitem>

</itemizedlist>

</para>

</section>

<title>What this Manual Does Not Provide</title>

83

84

<para>

85

This manual will not give you the following:

86

87

<listitem><para><emphasis>Step-by-step instructions when those instructions exist in other Yocto

88

Project documentation:</emphasis>

89

For example, the Yocto Project Application Developer's Guide contains detailed

90

instructions on how to run the

91

<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>ADT Installer</ulink>,

92

which is used to set up a cross-development environment.</para></listitem>

93

<listitem><para><emphasis>Reference material:</emphasis>

94

This type of material resides in an appropriate reference manual.

95

For example, system variables are documented in the

96

<ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.</para></listitem>

97

<listitem><para><emphasis>Detailed public information that is not specific to the Yocto Project:</emphasis>

98

For example, exhaustive information on how to use Git is covered better through the

99

Internet than in this manual.</para></listitem>

</itemizedlist>

</para>

</section>

<title>Other Information</title>

106

107

<para>

108

Because this manual presents overview information for many different

109

topics, supplemental information is recommended for full

110

comprehension.

111

The following list presents other sources of information you might find helpful:

112

113

<listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:

114

</emphasis> The home page for the Yocto Project provides lots of information on the project

115

as well as links to software and documentation.

116

</para></listitem>

117

118

<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis>

119

This short document lets you get started

120

with the Yocto Project and quickly begin building an image.

121

</para></listitem>

122

123

<ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis>

124

This manual is a reference

125

guide to the OpenEmbedded build system, which is based on BitBake.

126

The build system is sometimes referred to as "Poky".

127

</para></listitem>

128

129

<ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>:</emphasis>

130

This guide provides information that lets you get going with the Application

131

Development Toolkit (ADT) and stand-alone cross-development toolchains to

132

develop projects using the Yocto Project.

133

</para></listitem>

134

135

<ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis>

136

This guide defines the structure for BSP components.

137

Having a commonly understood structure encourages standardization.

138

</para></listitem>

139

140

<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:</emphasis>

141

This manual describes how to work with Linux Yocto kernels as well as provides a bit

142

of conceptual information on the construction of the Yocto Linux kernel tree.

143

</para></listitem>

144

145

<ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>:</emphasis>

146

This manual presents a set of common and generally useful tracing and

147

profiling schemes along with their applications (as appropriate) to each tool.

148

</para></listitem>

149

150

<ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>:</emphasis>

151

This manual introduces and describes how to set up and use

152

Toaster, which is a web interface to the Yocto Project's

</para></listitem>

Eclipse IDE Yocto Plug-in</ulink>:</emphasis>

158

A step-by-step instructional video that

159

demonstrates how an application developer uses Yocto Plug-in features within

the Eclipse IDE.

</para></listitem>

A list of commonly asked questions and their answers.

165

</para></listitem>

166

167

<ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:</emphasis>

168

Features, updates and known issues for the current

169

release of the Yocto Project.

</para></listitem>

A graphical user interface for BitBake.

174

Hob's primary goal is to enable a user to perform common tasks more easily.

175

</para></listitem>

176

177

<ulink url='&YOCTO_HOME_URL;/tools-resources/projects/toaster'>Toaster</ulink>:</emphasis>

178

An Application Programming Interface (API) and web-based

179

interface to the OpenEmbedded build system, which uses

180

BitBake, that reports build information.

181

</para></listitem>

182

183

<ulink url='&YOCTO_HOME_URL;/tools-resources/projects/build-appliance'>Build Appliance</ulink>:</emphasis>

184

A virtual machine that

185

enables you to build and boot a custom embedded Linux image

186

with the Yocto Project using a non-Linux development system.

187

</para></listitem>

188

189

<ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis>

190

The bug tracking application the Yocto Project uses.

191

If you find problems with the Yocto Project, you should report them using this

192

application.

193

</para></listitem>

194

<listitem><para><emphasis>Yocto Project Mailing Lists:</emphasis>

195

To subscribe to the Yocto Project mailing

196

lists, click on the following URLs and follow the instructions:

197

198

199

for a Yocto Project Discussions mailing list.

200

</para></listitem>

201

202

for a Yocto Project Discussions mailing list about the

203

OpenEmbedded build system (Poky).

204

</para></listitem>

205

206

for a mailing list to receive official Yocto Project announcements

207

as well as Yocto Project milestones.

208

</para></listitem>

209

210

for a listing of all public mailing lists on

211

<filename>lists.yoctoproject.org</filename>.

212

</para></listitem>

213

</itemizedlist></para></listitem>

214

<listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis>

215

Two IRC channels on freenode are available

216

for Yocto Project and Poky discussions: <filename>#yocto</filename> and

217

<filename>#poky</filename>, respectively.

218

</para></listitem>

219

220

<ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>

221

The build system used by the Yocto Project.

222

This project is the upstream, generic, embedded distribution

223

from which the Yocto Project derives its build system (Poky)

224

and to which it contributes.

225

</para></listitem>

226

227

<ulink url='http://www.openembedded.org/wiki/BitBake'>BitBake</ulink>:</emphasis>

228

The tool used by the OpenEmbedded build system

229

to process project metadata.

230

</para></listitem>

231

232

<ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual:</ulink></emphasis>

233

A comprehensive guide to the BitBake tool.

234

If you want information on BitBake, see this manual.

235

</para></listitem>

236

237

<ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>:</emphasis>

238

An open-source machine emulator and virtualizer.

</para></listitem>

</itemizedlist>

</para>

</section>

</chapter>

<!--

vim: expandtab tw=80 ts=4

246

-->