diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-newbie.xml')
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 77 |
1 files changed, 48 insertions, 29 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index d4f94c0cf1..c39024cd3f 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -10,7 +10,7 @@ | |||
10 | Working in this type of environment is different than working in a closed, proprietary environment. | 10 | Working in this type of environment is different than working in a closed, proprietary environment. |
11 | The chapter also presents information specific to the Yocto Project environment. | 11 | The chapter also presents information specific to the Yocto Project environment. |
12 | It specifically addresses licensing issues, code repositories, the open-source distributed version control | 12 | It specifically addresses licensing issues, code repositories, the open-source distributed version control |
13 | system Git, and best practices within Yocto Project. | 13 | system Git, and best practices using Yocto Project. |
14 | </para> | 14 | </para> |
15 | 15 | ||
16 | <note><para> | 16 | <note><para> |
@@ -59,13 +59,27 @@ | |||
59 | </section> | 59 | </section> |
60 | 60 | ||
61 | <section id='yocto-project-repositories'> | 61 | <section id='yocto-project-repositories'> |
62 | <title>Yocto Project Repositories</title> | 62 | <title>Yocto Project Source Repositories</title> |
63 | 63 | ||
64 | <para> | 64 | <para> |
65 | The Yocto Project team maintains complete source repositories that allow further development | 65 | The Yocto Project team maintains complete source repositories for all Yocto Project files |
66 | of Yocto Project, its tools, Board Support Packages, and so forth. | 66 | <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>here</ulink>. |
67 | As a developer who uses Yocto Project, however, you need only to be able to access your | 67 | This web-interface of the source is organized into categories by function such as |
68 | kernel or application source code and any layers (modifications) on which you might be working. | 68 | IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. |
69 | From the interface, you can click on any particular item in the "Name" column and | ||
70 | see the URL at the bottom of the page that you need to set up a Git repository for | ||
71 | that particular item. | ||
72 | The ability to create Git repositories of the Yocto Project source allows you to | ||
73 | make changes, contribute to the history, and ultimately enhance the Yocto Project's | ||
74 | tools, Board Support Packages, and so forth. | ||
75 | </para> | ||
76 | |||
77 | <para> | ||
78 | Conversely, if you are a developer that is not interested in contributing back to the | ||
79 | Yocto Project you have the ability to simply download and extract release tarballs | ||
80 | and use them within the Yocto Project environment. | ||
81 | All that is required is a particular release of Yocto Project, a kernel, and | ||
82 | your application source code. | ||
69 | </para> | 83 | </para> |
70 | 84 | ||
71 | <para> | 85 | <para> |
@@ -73,31 +87,36 @@ | |||
73 | <ulink url='http://www.yoctoproject.org/download'>download page</ulink> and get a | 87 | <ulink url='http://www.yoctoproject.org/download'>download page</ulink> and get a |
74 | <filename>.bz2</filename> tarball of the release. | 88 | <filename>.bz2</filename> tarball of the release. |
75 | You can also go to this site to download any supported BSP tarballs. | 89 | You can also go to this site to download any supported BSP tarballs. |
90 | Unpacking the tarball gives you a hierarchical directory structure of Yocto Project | ||
91 | files that lets you develop using the Yocto Project. | ||
76 | </para> | 92 | </para> |
77 | 93 | ||
78 | <para> | 94 | <para> |
79 | After obtaining the code, you can unpack the tarballs and have a working Git repository | 95 | Once you are set up through either tarball extraction or creation of Git repositories, |
80 | from which you can develop. | 96 | you are ready to develop. |
81 | Or, you can take steps to create local repositories of Yocto Project source code and metadata on | ||
82 | your development system. | ||
83 | See the information | ||
84 | <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>here</ulink> | ||
85 | for information on how to set up these local Git repositories. | ||
86 | </para> | 97 | </para> |
87 | 98 | ||
88 | <note><para> | 99 | <para> |
89 | Should you be interested in locations of complete Yocto Project development code, there are | 100 | In summary, here is where you can get the Yocto Project files needed for development: |
90 | two areas where this code is maintained: | 101 | <itemizedlist> |
91 | <itemizedlist> | 102 | <listitem><para><emphasis><ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>Source Repositories:</ulink></emphasis> |
92 | <listitem><para><emphasis><ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>Source Repositories:</ulink></emphasis> | 103 | This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto |
93 | This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto | 104 | Metadata Layers. |
94 | Metadata Layers.</para></listitem> | 105 | You can create Git repositories for each of these areas.</para></listitem> |
95 | <listitem><para><emphasis><ulink url='http://autobuilder.yoctoproject.org/downloads/'>Index of /downloads:</ulink></emphasis> | 106 | <listitem><para><emphasis><ulink url='http://autobuilder.yoctoproject.org/downloads/'>Index of /downloads:</ulink></emphasis> |
96 | This area contains an index of the Eclipse-plugin, miscellaneous support, poky, pseudo, and | 107 | This area contains an index of the Eclipse-plugin, miscellaneous support, poky, pseudo, and |
97 | all released versions of Yocto Project. | 108 | all released versions of Yocto Project in the form of images or tarballs. |
98 | [WRITER NOTE: link will be http://downloads.yoctoproject.org.]</para></listitem> | 109 | Downloading and extracting these files does not produce a Git repository but rather |
99 | </itemizedlist> | 110 | a snapshot of a particular release or image. |
100 | </para></note> | 111 | [WRITER NOTE: link will be http://downloads.yoctoproject.org.]</para></listitem> |
112 | <listitem><para><emphasis><ulink url='http://www.yoctoproject.org/download'>Yocto Project Download Page</ulink></emphasis> | ||
113 | This page on the Yocto Project website allows you to download any Yocto Project | ||
114 | release of Board Support Package (BSP) in tarball form. | ||
115 | The tarballs are similar to those found in the | ||
116 | <ulink url='http://autobuilder.yoctoproject.org/downloads/'>Index of /downloads:</ulink> area. | ||
117 | </para></listitem> | ||
118 | </itemizedlist> | ||
119 | </para> | ||
101 | </section> | 120 | </section> |
102 | 121 | ||
103 | <section id='licensing'> | 122 | <section id='licensing'> |
@@ -130,12 +149,12 @@ | |||
130 | </para> | 149 | </para> |
131 | 150 | ||
132 | <para> | 151 | <para> |
133 | When you build an image using Yocto Project the build process uses a known list of licenses to | 152 | When you build an image using Yocto Project, the build process uses a known list of licenses to |
134 | ensure compliance. | 153 | ensure compliance. |
135 | Once the build completes the list of all licenses found and used during the build are | 154 | Once the build completes, the list of all licenses found and used during the build are |
136 | kept in the resulting build directory at | 155 | kept in the resulting build directory at |
137 | <filename><build_directory>/tmp/deploy/images/licenses</filename>. | 156 | <filename><build_directory>/tmp/deploy/images/licenses</filename>. |
138 | If a module requires a license that is not in the base list then the build process | 157 | If a module requires a license that is not in the base list, the build process |
139 | generates a warning during the build. | 158 | generates a warning during the build. |
140 | It is up to the developer to resolve potential licensing issues. | 159 | It is up to the developer to resolve potential licensing issues. |
141 | </para> | 160 | </para> |