diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2018-01-03 12:56:07 -0800 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-02-14 15:25:27 +0000 |
| commit | 9f478d13585ca0ae129ffdb71a1b68b0202a2465 (patch) | |
| tree | 9719e6cd14ff2a5e83c07cc812f12c790c489a2b /documentation/dev-manual | |
| parent | 44ea6ded0e8e73f5258ce55bd1b851e24243b76a (diff) | |
| download | poky-9f478d13585ca0ae129ffdb71a1b68b0202a2465.tar.gz | |
dev-manual, ref-manual: Moved source file sections
The sections in the introductory chapter of the ref-manual are better
served as part of the dev-manual. These sections are about accessing
YP source files using various methods (i.e. source repositories,
index of releases, and nightly builds). I have integrated that
information into the dev-manual where the information was also being
treated.
(From yocto-docs rev: d3a97b1f9367d5bb5370974c8c5c0404df86724a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 85 |
1 files changed, 65 insertions, 20 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 195b22d0b1..ff8b56e62b 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
| @@ -278,9 +278,20 @@ | |||
| 278 | <title>Accessing Source Repositories</title> | 278 | <title>Accessing Source Repositories</title> |
| 279 | 279 | ||
| 280 | <para> | 280 | <para> |
| 281 | Yocto Project maintains upstream Git | 281 | Working from a copy of the upstream Yocto Project |
| 282 | <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> | 282 | <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> |
| 283 | that you can examine and access using a browser-based UI: | 283 | is the preferred method for obtaining and using a Yocto Project |
| 284 | release. | ||
| 285 | You can view the Yocto Project Source Repositories at | ||
| 286 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. | ||
| 287 | In particular, you can find the | ||
| 288 | <filename>poky</filename> repository at | ||
| 289 | <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/'></ulink>. | ||
| 290 | </para> | ||
| 291 | |||
| 292 | <para> | ||
| 293 | Use the following procedure to locate the latest upstream copy of | ||
| 294 | the <filename>poky</filename> Git repository: | ||
| 284 | <orderedlist> | 295 | <orderedlist> |
| 285 | <listitem><para> | 296 | <listitem><para> |
| 286 | <emphasis>Access Repositories:</emphasis> | 297 | <emphasis>Access Repositories:</emphasis> |
| @@ -290,8 +301,8 @@ | |||
| 290 | repositories. | 301 | repositories. |
| 291 | </para></listitem> | 302 | </para></listitem> |
| 292 | <listitem><para> | 303 | <listitem><para> |
| 293 | <emphasis>Select a Repository:</emphasis> | 304 | <emphasis>Select the Repository:</emphasis> |
| 294 | Click on any repository in which you are interested (e.g. | 305 | Click on the repository in which you are interested (i.e. |
| 295 | <filename>poky</filename>). | 306 | <filename>poky</filename>). |
| 296 | </para></listitem> | 307 | </para></listitem> |
| 297 | <listitem><para> | 308 | <listitem><para> |
| @@ -300,14 +311,11 @@ | |||
| 300 | <ulink url='&YOCTO_DOCS_REF_URL;#git-commands-clone'>clone</ulink> | 311 | <ulink url='&YOCTO_DOCS_REF_URL;#git-commands-clone'>clone</ulink> |
| 301 | that repository (e.g. | 312 | that repository (e.g. |
| 302 | <filename>&YOCTO_GIT_URL;/poky</filename>). | 313 | <filename>&YOCTO_GIT_URL;/poky</filename>). |
| 303 | </para></listitem> | 314 | <note> |
| 304 | <listitem><para> | 315 | For information on cloning a repository, see the |
| 305 | <emphasis>Examine Change History of the Repository:</emphasis> | 316 | "<link linkend='cloning-the-poky-repository'>Cloning the <filename>poky</filename> Repository</link>" |
| 306 | At the top of the page, click on any branch in which you | 317 | section. |
| 307 | might be interested (e.g. | 318 | </note> |
| 308 | <filename>&DISTRO_NAME_NO_CAP;</filename>). | ||
| 309 | You can then view the commit log or tree view for that | ||
| 310 | development branch. | ||
| 311 | </para></listitem> | 319 | </para></listitem> |
| 312 | </orderedlist> | 320 | </orderedlist> |
| 313 | </para> | 321 | </para> |
| @@ -319,12 +327,12 @@ | |||
| 319 | <para> | 327 | <para> |
| 320 | Yocto Project maintains an Index of Releases area that contains | 328 | Yocto Project maintains an Index of Releases area that contains |
| 321 | related files that contribute to the Yocto Project. | 329 | related files that contribute to the Yocto Project. |
| 322 | Rather than Git repositories, these files represent snapshot | 330 | Rather than Git repositories, these files are tarballs that |
| 323 | tarballs. | 331 | represent snapshots in time of a given component. |
| 324 | <note><title>Tip</title> | 332 | <note><title>Tip</title> |
| 325 | The recommended method for accessing Yocto Project | 333 | The recommended method for accessing Yocto Project |
| 326 | components is to use Git to clone a repository and work from | 334 | components is to use Git to clone the upstream repository and |
| 327 | within that local repository. | 335 | work from within that locally cloned repository. |
| 328 | The procedure in this section exists should you desire a | 336 | The procedure in this section exists should you desire a |
| 329 | tarball snapshot of any given component. | 337 | tarball snapshot of any given component. |
| 330 | </note> | 338 | </note> |
| @@ -342,8 +350,8 @@ | |||
| 342 | full array of released Poky tarballs. | 350 | full array of released Poky tarballs. |
| 343 | The <filename>poky</filename> directory in the | 351 | The <filename>poky</filename> directory in the |
| 344 | Index of Releases was historically used for very | 352 | Index of Releases was historically used for very |
| 345 | early releases and exists for retroactive | 353 | early releases and exists now only for retroactive |
| 346 | completeness only. | 354 | completeness. |
| 347 | </note> | 355 | </note> |
| 348 | </para></listitem> | 356 | </para></listitem> |
| 349 | <listitem><para> | 357 | <listitem><para> |
| @@ -361,7 +369,7 @@ | |||
| 361 | </para></listitem> | 369 | </para></listitem> |
| 362 | <listitem><para> | 370 | <listitem><para> |
| 363 | <emphasis>Download the Tarball:</emphasis> | 371 | <emphasis>Download the Tarball:</emphasis> |
| 364 | Click a tarball to download and save a snapshot of a | 372 | Click the tarball to download and save a snapshot of the |
| 365 | given component. | 373 | given component. |
| 366 | </para></listitem> | 374 | </para></listitem> |
| 367 | </orderedlist> | 375 | </orderedlist> |
| @@ -398,7 +406,7 @@ | |||
| 398 | </para></listitem> | 406 | </para></listitem> |
| 399 | <listitem><para> | 407 | <listitem><para> |
| 400 | <emphasis>Select the Type of Files:</emphasis> | 408 | <emphasis>Select the Type of Files:</emphasis> |
| 401 | Click the type of files you want (i.e "Build System", | 409 | Click the type of files you want such as "Build System", |
| 402 | "Tools", or "Board Support Packages (BSPs)". | 410 | "Tools", or "Board Support Packages (BSPs)". |
| 403 | </para></listitem> | 411 | </para></listitem> |
| 404 | <listitem><para> | 412 | <listitem><para> |
| @@ -410,6 +418,43 @@ | |||
| 410 | </para> | 418 | </para> |
| 411 | </section> | 419 | </section> |
| 412 | 420 | ||
| 421 | <section id='accessing-nightly-builds'> | ||
| 422 | <title>Accessing Nightly Builds</title> | ||
| 423 | |||
| 424 | <para> | ||
| 425 | Yocto Project maintains an area for nightly builds that contains | ||
| 426 | tarball releases at <ulink url='&YOCTO_AB_NIGHTLY_URL;'/>. | ||
| 427 | These builds include Yocto Project releases, SDK installation | ||
| 428 | scripts, and experimental builds. | ||
| 429 | </para> | ||
| 430 | |||
| 431 | <para> | ||
| 432 | Should you ever want to access a nightly build of a particular | ||
| 433 | Yocto Project component, use the following procedure: | ||
| 434 | <orderedlist> | ||
| 435 | <listitem><para> | ||
| 436 | <emphasis>Access the Nightly Builds:</emphasis> | ||
| 437 | Open a browser and go to | ||
| 438 | <ulink url='&YOCTO_AB_NIGHTLY_URL;'/> to access the | ||
| 439 | Nightly Builds. | ||
| 440 | </para></listitem> | ||
| 441 | <listitem><para> | ||
| 442 | <emphasis>Select a Build:</emphasis> | ||
| 443 | Click on any build by date in which you are interested. | ||
| 444 | </para></listitem> | ||
| 445 | <listitem><para> | ||
| 446 | <emphasis>Find the Tarball:</emphasis> | ||
| 447 | Drill down to find the associated tarball. | ||
| 448 | </para></listitem> | ||
| 449 | <listitem><para> | ||
| 450 | <emphasis>Download the Tarball:</emphasis> | ||
| 451 | Click the tarball to download and save a snapshot of the | ||
| 452 | given component. | ||
| 453 | </para></listitem> | ||
| 454 | </orderedlist> | ||
| 455 | </para> | ||
| 456 | </section> | ||
| 457 | |||
| 413 | <section id='cloning-the-poky-repository'> | 458 | <section id='cloning-the-poky-repository'> |
| 414 | <title>Cloning the <filename>poky</filename> Repository</title> | 459 | <title>Cloning the <filename>poky</filename> Repository</title> |
| 415 | 460 | ||
