From 1ad79777424cc9e155a06cdabf19a4c9b3aa66c7 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 23 Jan 2012 11:32:12 -0600 Subject: documentation/dev-manual: Changes to repo names and kernel example. To make the kernel example more easily understood, Joshua Lock suggested that the names used for the bare clone of the kernel git repo and the copy of the bare clone be more different. So I have changed the example such that the bare clone repo is named linux-yocto-3.0-1.1.x.git and the copy of the bare clone (or working repo) is named my-linux-yocto-3.0-1.1.x-work. Note that this also implies the use of the linux-yocto_3.0-1.1.x kernel and not the linux-yocto_3.0 kernel. All the changes made here should take care of the example. I did have to introduce a new figure that showed the kernel repos based on the new names used in the example. Also, I had to delete the other from this branch. The examples are now diverging according to (master) work and 1.1.x work. Reported-by: Joshua Lock (From yocto-docs rev: f4fdef6078fccfc2c72b6e0ad1dfae1f1ecb2aa6) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-kernel-appendix.xml | 18 +++++++++--------- documentation/dev-manual/dev-manual-model.xml | 8 ++++++-- documentation/dev-manual/dev-manual-start.xml | 14 +++++++------- .../figures/kernel-example-repos-edison.png | Bin 0 -> 25322 bytes .../dev-manual/figures/kernel-example-repos.png | Bin 24951 -> 0 bytes 5 files changed, 22 insertions(+), 18 deletions(-) create mode 100644 documentation/dev-manual/figures/kernel-example-repos-edison.png delete mode 100644 documentation/dev-manual/figures/kernel-example-repos.png (limited to 'documentation') diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml index ea59406696..12cb20eb46 100644 --- a/documentation/dev-manual/dev-manual-kernel-appendix.xml +++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml @@ -65,7 +65,7 @@ - @@ -178,7 +178,7 @@ Setting Up the Bare Clone and its Copy - This example modifies the linux-yocto-3.0 kernel. + This example modifies the linux-yocto-3.0-1.1.x kernel. Thus, you need to create a bare clone of that kernel and then make a copy of the bare clone. See the bulleted item @@ -190,12 +190,12 @@ The bare clone exists for the kernel build tools and simply as the receiving end of git push commands after you make edits and commits inside the copy of the clone. - The copy (linux-yocto-3.0 in this example) has to have + The copy (my-linux-yocto-3.0-1.1.x-work in this example) has to have a local branch created and checked out for your work. This example uses common-pc-base as the local branch. The following commands create and checkout the branch: - $ cd ~/linux-yocto-3.0 + $ cd ~/my-linux-yocto-3.0-1.1.x $ git checkout -b common-pc-base origin/yocto/standard/common-pc/base Branch common-pc-base set up to track remote branch yocto/standard/common-pc/base from origin. @@ -290,7 +290,7 @@ The file you change in this example is named calibrate.c - and is located in the linux-yocto-3.0 Git repository + and is located in the my-linux-yocto-3.0-1.1.x-work Git repository (the copy of the bare clone) in init. This example simply inserts several printk statements at the beginning of the calibrate_delay function. @@ -415,13 +415,13 @@ poky-extras/meta-kernel-dev/recipes-kernel/linux directory, you need to identify the location of the local source code, which in this example is the bare clone named - linux-yocto-3.0.git. + linux-yocto-3.0-1.1.x.git. To do this, set the KSRC_linux_yocto variable to point to your - local linux-yocto-3.0.git Git repository by adding the + local linux-yocto-3.0-1.1.x.git Git repository by adding the following statement. Be sure to substitute your user information in the statement: - KSRC_linux_yocto ?= /home/scottrif/linux-yocto-3.0.git + KSRC_linux_yocto ?= /home/scottrif/linux-yocto-3.0-1.1.x.git Specify the Kernel Machine: Also in the linux-yocto_3.0.bbappend file, you need to specify @@ -598,7 +598,7 @@ After setting up the environment to run menuconfig, you are ready to use the tool to interactively change the kernel configuration. - In this example, we are basing our changes on the linux-yocto-3.0 + In this example, we are basing our changes on the linux-yocto-3.0-1.1.x kernel. The Yocto Project build environment recognizes this kernel as linux-yocto. diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 4b625d1831..abe26e90a6 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -231,8 +231,12 @@ stable Linux Yocto kernel that is based on the Linux 2.6.34 release. linux-yocto-2.6.37 - The stable Linux Yocto kernel that is based on the Linux 2.6.37 release. - linux-yocto-3.0 - The current - Linux Yocto kernel that is based on the Linux 3.0 release. + linux-yocto-3.0 - The + stable Linux Yocto kernel to use with the Yocto Project current (master) development. + This kernel is based on the Linux 3.0 release. + linux-yocto-3.0-1.1.x - The + stable Linux Yocto kernel to use with the Yocto Project Release 1.1.x. + This kernel is based on the Linux 3.0 release. linux-yocto-dev - A development kernel based on the latest upstream release candidate available. diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 5cdc34be9c..d9f042bc61 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -117,18 +117,18 @@ For simplicity, it is recommended that you create these structures outside of the Yocto Project files' Git repository. As an example, the following transcript shows how to create the bare clone - of the linux-yocto-3.0 kernel and then create a copy of + of the linux-yocto-3.0-1.1.x kernel and then create a copy of that clone. When you have a local Linux Yocto kernel Git repository, you can reference that repository rather than the upstream Git repository as part of the clone command. Doing so can speed up the process. In the following example, the bare clone is named - linux-yocto-3.0.git, while the - copy is named linux-yocto-3.0: + linux-yocto-3.0-1.1.x.git, while the + copy is named my-linux-yocto-3.0-1.1.x-work: - $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.0 linux-yocto-3.0.git - Initialized empty Git repository in /home/scottrif/linux-yocto-3.0.git/ + $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.0-1.1.x linux-yocto-3.0-1.1.x.git + Initialized empty Git repository in /home/scottrif/linux-yocto-3.0-1.1.x.git/ remote: Counting objects: 2259181, done. remote: Compressing objects: 100% (373259/373259), done. remote: Total 2259181 (delta 1892638), reused 2231556 (delta 1865300) @@ -137,8 +137,8 @@ Now create a clone of the bare clone just created: - $ git clone linux-yocto-3.0.git linux-yocto-3.0 - Initialized empty Git repository in /home/scottrif/linux-yocto-3.0/.git/ + $ git clone linux-yocto-3.0-1.1.x.git my-linux-yocto-3.0-1.1.x-work + Initialized empty Git repository in /home/scottrif/my-linux-yocto-3.0-1.1.x/.git/ Checking out files: 100% (36898/36898), done. diff --git a/documentation/dev-manual/figures/kernel-example-repos-edison.png b/documentation/dev-manual/figures/kernel-example-repos-edison.png new file mode 100644 index 0000000000..f442be967d Binary files /dev/null and b/documentation/dev-manual/figures/kernel-example-repos-edison.png differ diff --git a/documentation/dev-manual/figures/kernel-example-repos.png b/documentation/dev-manual/figures/kernel-example-repos.png deleted file mode 100644 index dce50bea0a..0000000000 Binary files a/documentation/dev-manual/figures/kernel-example-repos.png and /dev/null differ -- cgit v1.2.3-54-g00ecf