diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-newbie.xml')
| -rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 90 |
1 files changed, 2 insertions, 88 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 4fae151432..a881295ce0 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
| @@ -317,7 +317,7 @@ | |||
| 317 | Separate the project's Metadata and code by using | 317 | Separate the project's Metadata and code by using |
| 318 | separate Git repositories. | 318 | separate Git repositories. |
| 319 | See the | 319 | See the |
| 320 | "<link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>" | 320 | "<ulink url='&YOCTO_DOC_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" |
| 321 | section for information on these repositories. | 321 | section for information on these repositories. |
| 322 | See the | 322 | See the |
| 323 | "<link linkend='getting-setup'>Getting Set Up</link>" | 323 | "<link linkend='getting-setup'>Getting Set Up</link>" |
| @@ -354,92 +354,6 @@ | |||
| 354 | </section> | 354 | </section> |
| 355 | </section> | 355 | </section> |
| 356 | 356 | ||
| 357 | <section id='yocto-project-repositories'> | ||
| 358 | <title>Yocto Project Source Repositories</title> | ||
| 359 | |||
| 360 | <para> | ||
| 361 | The Yocto Project team maintains complete source repositories for all | ||
| 362 | Yocto Project files at | ||
| 363 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>. | ||
| 364 | This web-based source code browser is organized into categories by | ||
| 365 | function such as IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and | ||
| 366 | so forth. | ||
| 367 | From the interface, you can click on any particular item in the "Name" | ||
| 368 | column and see the URL at the bottom of the page that you need to clone | ||
| 369 | a Git repository for that particular item. | ||
| 370 | Having a local Git repository of the | ||
| 371 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>, which is | ||
| 372 | usually named "poky", allows | ||
| 373 | you to make changes, contribute to the history, and ultimately enhance | ||
| 374 | the Yocto Project's tools, Board Support Packages, and so forth. | ||
| 375 | </para> | ||
| 376 | |||
| 377 | <para> | ||
| 378 | For any supported release of Yocto Project, you can also go to the | ||
| 379 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and | ||
| 380 | select the "Downloads" tab and get a released tarball of the | ||
| 381 | <filename>poky</filename> repository or any supported BSP tarballs. | ||
| 382 | Unpacking these tarballs gives you a snapshot of the released | ||
| 383 | files. | ||
| 384 | <note><title>Notes</title> | ||
| 385 | <itemizedlist> | ||
| 386 | <listitem><para> | ||
| 387 | The recommended method for setting up the Yocto Project | ||
| 388 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> | ||
| 389 | and the files for supported BSPs | ||
| 390 | (e.g., <filename>meta-intel</filename>) is to use | ||
| 391 | <link linkend='git'>Git</link> to create a local copy of | ||
| 392 | the upstream repositories. | ||
| 393 | </para></listitem> | ||
| 394 | <listitem><para> | ||
| 395 | Be sure to always work in matching branches for both | ||
| 396 | the selected BSP repository and the | ||
| 397 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> | ||
| 398 | (i.e. <filename>poky</filename>) repository. | ||
| 399 | For example, if you have checked out the "master" branch | ||
| 400 | of <filename>poky</filename> and you are going to use | ||
| 401 | <filename>meta-intel</filename>, be sure to checkout the | ||
| 402 | "master" branch of <filename>meta-intel</filename>. | ||
| 403 | </para></listitem> | ||
| 404 | </itemizedlist> | ||
| 405 | </note> | ||
| 406 | </para> | ||
| 407 | |||
| 408 | <para> | ||
| 409 | In summary, here is where you can get the project files needed for development: | ||
| 410 | <itemizedlist> | ||
| 411 | <listitem><para id='source-repositories'><emphasis><ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'>Source Repositories:</ulink></emphasis> | ||
| 412 | This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto | ||
| 413 | Metadata Layers. | ||
| 414 | You can create local copies of Git repositories for each of these areas.</para> | ||
| 415 | <para> | ||
| 416 | <imagedata fileref="figures/source-repos.png" align="center" width="6in" depth="4in" /> | ||
| 417 | </para></listitem> | ||
| 418 | <listitem><para><anchor id='index-downloads' /><emphasis><ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink></emphasis> | ||
| 419 | This is an index of releases such as | ||
| 420 | the <trademark class='trade'>Eclipse</trademark> | ||
| 421 | Yocto Plug-in, miscellaneous support, Poky, Pseudo, installers for cross-development toolchains, | ||
| 422 | and all released versions of Yocto Project in the form of images or tarballs. | ||
| 423 | Downloading and extracting these files does not produce a local copy of the | ||
| 424 | Git repository but rather a snapshot of a particular release or image.</para> | ||
| 425 | <para> | ||
| 426 | <imagedata fileref="figures/index-downloads.png" align="center" width="6in" depth="3.5in" /> | ||
| 427 | </para></listitem> | ||
| 428 | <listitem><para><emphasis>"Downloads" page for the | ||
| 429 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:</emphasis> | ||
| 430 | Access this page by going to the website and then selecting | ||
| 431 | the "Downloads" tab. | ||
| 432 | This page allows you to download any Yocto Project | ||
| 433 | release or Board Support Package (BSP) in tarball form. | ||
| 434 | The tarballs are similar to those found in the | ||
| 435 | <ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink> area.</para> | ||
| 436 | <para> | ||
| 437 | <imagedata fileref="figures/yp-download.png" align="center" width="6in" depth="4in" /> | ||
| 438 | </para></listitem> | ||
| 439 | </itemizedlist> | ||
| 440 | </para> | ||
| 441 | </section> | ||
| 442 | |||
| 443 | <section id='licensing'> | 357 | <section id='licensing'> |
| 444 | <title>Licensing</title> | 358 | <title>Licensing</title> |
| 445 | 359 | ||
| @@ -540,7 +454,7 @@ | |||
| 540 | 454 | ||
| 541 | <para> | 455 | <para> |
| 542 | As mentioned earlier in the section | 456 | As mentioned earlier in the section |
| 543 | "<link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>", | 457 | "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>", |
| 544 | the Yocto Project maintains source repositories at | 458 | the Yocto Project maintains source repositories at |
| 545 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. | 459 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. |
| 546 | If you look at this web-interface of the repositories, each item is a separate | 460 | If you look at this web-interface of the repositories, each item is a separate |
