From 216ee69227fe97c19d5da4c3d828b7cc5d8a437f Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 14 Jun 2017 11:17:21 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/Makefile | 6 +- documentation/bsp-guide/bsp.xml | 2 +- .../dev-manual/dev-manual-common-tasks.xml | 2 +- documentation/dev-manual/dev-manual-newbie.xml | 90 +----------------- .../dev-manual/figures/index-downloads.png | Bin 100374 -> 0 bytes documentation/dev-manual/figures/source-repos.png | Bin 188986 -> 0 bytes documentation/dev-manual/figures/yp-download.png | Bin 230971 -> 0 bytes documentation/kernel-dev/kernel-dev-advanced.xml | 2 +- .../ref-manual/figures/index-downloads.png | Bin 0 -> 100374 bytes documentation/ref-manual/figures/source-repos.png | Bin 0 -> 188986 bytes documentation/ref-manual/figures/yp-download.png | Bin 0 -> 230971 bytes documentation/ref-manual/migration.xml | 4 +- .../ref-manual/ref-development-environment.xml | 101 +++++++++++++++++++++ documentation/ref-manual/ref-release-process.xml | 4 +- 14 files changed, 113 insertions(+), 98 deletions(-) delete mode 100644 documentation/dev-manual/figures/index-downloads.png delete mode 100644 documentation/dev-manual/figures/source-repos.png delete mode 100644 documentation/dev-manual/figures/yp-download.png create mode 100644 documentation/ref-manual/figures/index-downloads.png create mode 100644 documentation/ref-manual/figures/source-repos.png create mode 100644 documentation/ref-manual/figures/yp-download.png diff --git a/documentation/Makefile b/documentation/Makefile index 9077c81215..131c0b7f33 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -130,9 +130,8 @@ TARFILES = dev-style.css dev-manual.html \ TARFILES = dev-style.css dev-manual.html \ figures/bsp-dev-flow.png \ figures/dev-title.png figures/git-workflow.png \ - figures/index-downloads.png figures/kernel-dev-flow.png \ + figures/kernel-dev-flow.png \ figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \ - figures/source-repos.png figures/yp-download.png \ figures/recipe-workflow.png \ figures/devtool-add-flow.png figures/devtool-modify-flow.png \ figures/devtool-upgrade-flow.png \ @@ -271,7 +270,8 @@ TARFILES = ref-manual.html ref-style.css figures/poky-title.png \ figures/patching.png figures/configuration-compile-autoreconf.png \ figures/analysis-for-package-splitting.png figures/image-generation.png \ figures/sdk-generation.png figures/building-an-image.png \ - figures/build-workspace-directory.png + figures/build-workspace-directory.png figures/source-repos.png \ + figures/index-downloads.png figures/yp-download.png MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse FIGURES = figures STYLESHEET = $(DOC)/*.css diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 40c2a7dd27..7dc7ad37d9 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -55,7 +55,7 @@ To help understand the BSP layer concept, consider the BSPs that the Yocto Project supports and provides with each release. You can see the layers in the - Yocto Project Source Repositories + Yocto Project Source Repositories through a web interface at . If you go to that interface, you will find near the bottom of the list 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 @@ connman.inc file in the meta/recipes-connectivity/connman/ directory of the poky - source repository. + source repository. You can also find examples in meta/classes/kernel.bbclass. 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 @@ Separate the project's Metadata and code by using separate Git repositories. See the - "Yocto Project Source Repositories" + "Yocto Project Source Repositories" section for information on these repositories. See the "Getting Set Up" @@ -354,92 +354,6 @@ -
- Yocto Project Source Repositories - - - The Yocto Project team maintains complete source repositories for all - Yocto Project files at - . - This web-based source code browser is organized into categories by - function such as IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and - so forth. - From the interface, you can click on any particular item in the "Name" - column and see the URL at the bottom of the page that you need to clone - a Git repository for that particular item. - Having a local Git repository of the - Source Directory, which is - usually named "poky", allows - you to make changes, contribute to the history, and ultimately enhance - the Yocto Project's tools, Board Support Packages, and so forth. - - - - For any supported release of Yocto Project, you can also go to the - Yocto Project Website and - select the "Downloads" tab and get a released tarball of the - poky repository or any supported BSP tarballs. - Unpacking these tarballs gives you a snapshot of the released - files. - Notes - - - The recommended method for setting up the Yocto Project - Source Directory - and the files for supported BSPs - (e.g., meta-intel) is to use - Git to create a local copy of - the upstream repositories. - - - Be sure to always work in matching branches for both - the selected BSP repository and the - Source Directory - (i.e. poky) repository. - For example, if you have checked out the "master" branch - of poky and you are going to use - meta-intel, be sure to checkout the - "master" branch of meta-intel. - - - - - - - In summary, here is where you can get the project files needed for development: - - Source Repositories: - This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto - Metadata Layers. - You can create local copies of Git repositories for each of these areas. - - - - Index of /releases: - This is an index of releases such as - the Eclipse - Yocto Plug-in, miscellaneous support, Poky, Pseudo, installers for cross-development toolchains, - and all released versions of Yocto Project in the form of images or tarballs. - Downloading and extracting these files does not produce a local copy of the - Git repository but rather a snapshot of a particular release or image. - - - - "Downloads" page for the - Yocto Project Website: - Access this page by going to the website and then selecting - the "Downloads" tab. - This page allows you to download any Yocto Project - release or Board Support Package (BSP) in tarball form. - The tarballs are similar to those found in the - Index of /releases: area. - - - - - -
-
Licensing @@ -540,7 +454,7 @@ As mentioned earlier in the section - "Yocto Project Source Repositories", + "Yocto Project Source Repositories", the Yocto Project maintains source repositories at . 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 Binary files a/documentation/dev-manual/figures/index-downloads.png and /dev/null 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 Binary files a/documentation/dev-manual/figures/source-repos.png and /dev/null 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 Binary files a/documentation/dev-manual/figures/yp-download.png and /dev/null differ diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml index 22afc66587..0394e08444 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.xml +++ b/documentation/kernel-dev/kernel-dev-advanced.xml @@ -658,7 +658,7 @@ Consider the Minnow BSP definition from the linux-yocto-4.4 in the Yocto Project - Source Repositories + Source Repositories (i.e. yocto-kernel-cache/bsp/minnow): diff --git a/documentation/ref-manual/figures/index-downloads.png b/documentation/ref-manual/figures/index-downloads.png new file mode 100644 index 0000000000..41251d5d18 Binary files /dev/null and b/documentation/ref-manual/figures/index-downloads.png differ diff --git a/documentation/ref-manual/figures/source-repos.png b/documentation/ref-manual/figures/source-repos.png new file mode 100644 index 0000000000..65c5f29a43 Binary files /dev/null and b/documentation/ref-manual/figures/source-repos.png differ diff --git a/documentation/ref-manual/figures/yp-download.png b/documentation/ref-manual/figures/yp-download.png new file mode 100644 index 0000000000..5770be6883 Binary files /dev/null and b/documentation/ref-manual/figures/yp-download.png differ diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index b6b067b910..a3dc1ee1f6 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml @@ -293,7 +293,7 @@ For the remainder, you can now find them in the meta-extras repository, which is in the Yocto Project - Source Repositories. + Source Repositories.
@@ -4035,7 +4035,7 @@ $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64. For an example, see the pixbufcache class in meta/classes/ in the Yocto Project - Source Repositories. + Source Repositories. The SSTATEPOSTINSTFUNCS variable itself is now deprecated in favor of the diff --git a/documentation/ref-manual/ref-development-environment.xml b/documentation/ref-manual/ref-development-environment.xml index b19058ed03..6d4a76792e 100644 --- a/documentation/ref-manual/ref-development-environment.xml +++ b/documentation/ref-manual/ref-development-environment.xml @@ -65,6 +65,107 @@ +
+ Yocto Project Source Repositories + + + The Yocto Project team maintains complete source repositories for all + Yocto Project files at + . + This web-based source code browser is organized into categories by + function such as IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and + so forth. + From the interface, you can click on any particular item in the "Name" + column and see the URL at the bottom of the page that you need to clone + a Git repository for that particular item. + Having a local Git repository of the + Source Directory, which is + usually named "poky", allows + you to make changes, contribute to the history, and ultimately enhance + the Yocto Project's tools, Board Support Packages, and so forth. + + + + For any supported release of Yocto Project, you can also go to the + Yocto Project Website and + select the "Downloads" tab and get a released tarball of the + poky repository or any supported BSP tarballs. + Unpacking these tarballs gives you a snapshot of the released + files. + Notes + + + The recommended method for setting up the Yocto Project + Source Directory + and the files for supported BSPs + (e.g., meta-intel) is to use + Git to create a local copy of + the upstream repositories. + + + Be sure to always work in matching branches for both + the selected BSP repository and the + Source Directory + (i.e. poky) repository. + For example, if you have checked out the "master" branch + of poky and you are going to use + meta-intel, be sure to checkout the + "master" branch of meta-intel. + + + + + + + In summary, here is where you can get the project files needed for + development: + + + + Source Repositories: + + This area contains IDE Plugins, Matchbox, Poky, Poky Support, + Tools, Yocto Linux Kernel, and Yocto Metadata Layers. + You can create local copies of Git repositories for each of + these areas. + + + + + + + Index of /releases: + + This is an index of releases such as + the Eclipse + Yocto Plug-in, miscellaneous support, Poky, Pseudo, installers + for cross-development toolchains, and all released versions of + Yocto Project in the form of images or tarballs. + Downloading and extracting these files does not produce a local + copy of the Git repository but rather a snapshot of a + particular release or image. + + + + + + "Downloads" page for the + Yocto Project Website: + + Access this page by going to the website and then selecting + the "Downloads" tab. + This page allows you to download any Yocto Project + release or Board Support Package (BSP) in tarball form. + The tarballs are similar to those found in the + Index of /releases: area. + + + + + + +
+
Development Concepts diff --git a/documentation/ref-manual/ref-release-process.xml b/documentation/ref-manual/ref-release-process.xml index aa1ff89a7d..6f5b1784e3 100644 --- a/documentation/ref-manual/ref-release-process.xml +++ b/documentation/ref-manual/ref-release-process.xml @@ -61,7 +61,7 @@ Each major release receives a codename that identifies the release in the - Yocto Project Source Repositories. + Yocto Project Source Repositories. The concept is that branches of Metadata with the same codename are likely to be compatible and thus @@ -216,7 +216,7 @@ in the poky repository. You can find all these branches in the Yocto Project - Source Repositories. + Source Repositories. Testing within these public branches ensures in a publicly visible way that all of the main supposed architectures and recipes in OE-Core -- cgit v1.2.3-54-g00ecf