diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2017-06-14 11:17:21 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-06-22 09:16:43 +0100 |
commit | 216ee69227fe97c19d5da4c3d828b7cc5d8a437f (patch) | |
tree | 468474516f0450c7c79c5c8d22589a4b5c52739a /documentation/dev-manual | |
parent | 12cc5f7ab27ae9ed4e9131e81b91de7606faa278 (diff) | |
download | poky-216ee69227fe97c19d5da4c3d828b7cc5d8a437f.tar.gz |
documentation: Moved "Yocto Project Source Repositories" section
Fixes [YOCTO #11630]
The "Yocto Project Source Repositories" section is purely conceptual
and thus does not belong in the reconstituted dev-manual, which is
converting to a "how-to" manual. I have moved this section to the
ref-manual under "The Yocto Project Development Environment" section.
Moving the section affected several things. Three figures that where
in the dev-manual were copied and moved to the figures folder of the
ref-manual. This required deleting them from the dev-manual and
adding them to the ref-manual.
The makefile had to be edited to move those figures into the ref-manual
and delete them from the latest version of the dev-manual in order for
the tarball of files to be correct when the manuals are made.
Links to anchors within the moved section had to be fixed in various
manuals. Links to the main section "id" had to be fixed to point
to the ref-manual manual.
(From yocto-docs rev: c619ae2bbc6be93cb0324ca44e936eefec12b28c)
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-common-tasks.xml | 2 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 90 | ||||
-rw-r--r-- | documentation/dev-manual/figures/index-downloads.png | bin | 100374 -> 0 bytes | |||
-rw-r--r-- | documentation/dev-manual/figures/source-repos.png | bin | 188986 -> 0 bytes | |||
-rw-r--r-- | documentation/dev-manual/figures/yp-download.png | bin | 230971 -> 0 bytes |
5 files changed, 3 insertions, 89 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 0a9c1800e3..1d5859ddc9 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -8335,7 +8335,7 @@ | |||
8335 | <filename>connman.inc</filename> file in the | 8335 | <filename>connman.inc</filename> file in the |
8336 | <filename>meta/recipes-connectivity/connman/</filename> | 8336 | <filename>meta/recipes-connectivity/connman/</filename> |
8337 | directory of the <filename>poky</filename> | 8337 | directory of the <filename>poky</filename> |
8338 | <link linkend='yocto-project-repositories'>source repository</link>. | 8338 | <ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>source repository</ulink>. |
8339 | You can also find examples in | 8339 | You can also find examples in |
8340 | <filename>meta/classes/kernel.bbclass</filename>. | 8340 | <filename>meta/classes/kernel.bbclass</filename>. |
8341 | </para> | 8341 | </para> |
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 |
diff --git a/documentation/dev-manual/figures/index-downloads.png b/documentation/dev-manual/figures/index-downloads.png deleted file mode 100644 index 41251d5d18..0000000000 --- a/documentation/dev-manual/figures/index-downloads.png +++ /dev/null | |||
Binary files differ | |||
diff --git a/documentation/dev-manual/figures/source-repos.png b/documentation/dev-manual/figures/source-repos.png deleted file mode 100644 index 65c5f29a43..0000000000 --- a/documentation/dev-manual/figures/source-repos.png +++ /dev/null | |||
Binary files differ | |||
diff --git a/documentation/dev-manual/figures/yp-download.png b/documentation/dev-manual/figures/yp-download.png deleted file mode 100644 index 5770be6883..0000000000 --- a/documentation/dev-manual/figures/yp-download.png +++ /dev/null | |||
Binary files differ | |||