diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-01-29 15:18:03 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-02-14 15:25:29 +0000 |
commit | ae06e04cd225d2c2147ca355e2dd39b4f6cf6775 (patch) | |
tree | c920e85262a91e7626279e7dcbbd56a299919f49 /documentation/getting-started/eclipse/html/getting-started/sources-dev-environment.html | |
parent | ebc7de094881dd8f2450aa4fdf548f2e9c835df1 (diff) | |
download | poky-ae06e04cd225d2c2147ca355e2dd39b4f6cf6775.tar.gz |
documentation: Created new "Getting Started" manual.
Creation involved removing the overview-manual and replacing it
with the getting-started manual. All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".
The style sheet for the new manual needed updating to display the
new .PNG image for the title page. The mega-manual file had to
be updated to include the files. The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.
(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/getting-started/eclipse/html/getting-started/sources-dev-environment.html')
-rw-r--r-- | documentation/getting-started/eclipse/html/getting-started/sources-dev-environment.html | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/documentation/getting-started/eclipse/html/getting-started/sources-dev-environment.html b/documentation/getting-started/eclipse/html/getting-started/sources-dev-environment.html new file mode 100644 index 0000000000..ab7718074f --- /dev/null +++ b/documentation/getting-started/eclipse/html/getting-started/sources-dev-environment.html | |||
@@ -0,0 +1,80 @@ | |||
1 | <html> | ||
2 | <head> | ||
3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | ||
4 | <title>2.8.3. Sources</title> | ||
5 | <link rel="stylesheet" type="text/css" href="../book.css"> | ||
6 | <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> | ||
7 | <link rel="home" href="index.html" title="Getting Started With Yocto Project"> | ||
8 | <link rel="up" href="development-concepts.html" title="2.8. Development Concepts"> | ||
9 | <link rel="prev" href="software-layer.html" title="2.8.2.3. Software Layer"> | ||
10 | <link rel="next" href="upstream-project-releases.html" title="2.8.3.1. Upstream Project Releases"> | ||
11 | </head> | ||
12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="section" title="2.8.3. Sources"> | ||
13 | <div class="titlepage"><div><div><h3 class="title"> | ||
14 | <a name="sources-dev-environment"></a>2.8.3. Sources</h3></div></div></div> | ||
15 | <p> | ||
16 | In order for the OpenEmbedded build system to create an image or | ||
17 | any target, it must be able to access source files. | ||
18 | The | ||
19 | <a class="link" href="development-concepts.html#general-yocto-environment-figure">general Yocto Project Development Environment figure</a> | ||
20 | represents source files using the "Upstream Project Releases", | ||
21 | "Local Projects", and "SCMs (optional)" boxes. | ||
22 | The figure represents mirrors, which also play a role in locating | ||
23 | source files, with the "Source Mirror(s)" box. | ||
24 | </p> | ||
25 | <p> | ||
26 | The method by which source files are ultimately organized is | ||
27 | a function of the project. | ||
28 | For example, for released software, projects tend to use tarballs | ||
29 | or other archived files that can capture the state of a release | ||
30 | guaranteeing that it is statically represented. | ||
31 | On the other hand, for a project that is more dynamic or | ||
32 | experimental in nature, a project might keep source files in a | ||
33 | repository controlled by a Source Control Manager (SCM) such as | ||
34 | Git. | ||
35 | Pulling source from a repository allows you to control | ||
36 | the point in the repository (the revision) from which you want to | ||
37 | build software. | ||
38 | Finally, a combination of the two might exist, which would give the | ||
39 | consumer a choice when deciding where to get source files. | ||
40 | </p> | ||
41 | <p> | ||
42 | BitBake uses the | ||
43 | <a class="link" href="../ref-manual/var-SRC_URI.html" target="_self"><code class="filename">SRC_URI</code></a> | ||
44 | variable to point to source files regardless of their location. | ||
45 | Each recipe must have a <code class="filename">SRC_URI</code> variable | ||
46 | that points to the source. | ||
47 | </p> | ||
48 | <p> | ||
49 | Another area that plays a significant role in where source files | ||
50 | come from is pointed to by the | ||
51 | <a class="link" href="../ref-manual/var-DL_DIR.html" target="_self"><code class="filename">DL_DIR</code></a> | ||
52 | variable. | ||
53 | This area is a cache that can hold previously downloaded source. | ||
54 | You can also instruct the OpenEmbedded build system to create | ||
55 | tarballs from Git repositories, which is not the default behavior, | ||
56 | and store them in the <code class="filename">DL_DIR</code> by using the | ||
57 | <a class="link" href="../ref-manual/var-BB_GENERATE_MIRROR_TARBALLS.html" target="_self"><code class="filename">BB_GENERATE_MIRROR_TARBALLS</code></a> | ||
58 | variable. | ||
59 | </p> | ||
60 | <p> | ||
61 | Judicious use of a <code class="filename">DL_DIR</code> directory can | ||
62 | save the build system a trip across the Internet when looking | ||
63 | for files. | ||
64 | A good method for using a download directory is to have | ||
65 | <code class="filename">DL_DIR</code> point to an area outside of your | ||
66 | Build Directory. | ||
67 | Doing so allows you to safely delete the Build Directory | ||
68 | if needed without fear of removing any downloaded source file. | ||
69 | </p> | ||
70 | <p> | ||
71 | The remainder of this section provides a deeper look into the | ||
72 | source files and the mirrors. | ||
73 | Here is a more detailed look at the source file area of the | ||
74 | base figure: | ||
75 | </p> | ||
76 | <table border="0" summary="manufactured viewport for HTML img" cellspacing="0" cellpadding="0" width="630"><tr style="height: 675px"><td align="center"><img src="figures/source-input.png" align="middle" width="630"></td></tr></table> | ||
77 | <p> | ||
78 | </p> | ||
79 | </div></body> | ||
80 | </html> | ||