From 6f6d0a59e3b6b8a75522d2918b98de735718f425 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 3 Apr 2013 08:51:38 -0700 Subject: [PATCH] ref-manual, dev-manual: Applied review edits (read-only rootfs and package repo) A couple sets of review comments from Paul applied here. 1. Added the "read-only-rootfs" item to the EXTRA_IMAGE_FEATURES variable description and a link to the appropriate section in the dev-manual. 2. Pulled the how-to-create a package repository section out of the section on how to customize an image with the IMAGE_FEATURES and EXTRA_IMAGE_FEATURES section and made it a stand-alone section in the "Tasks" chapter of the dev-manual. 3. Integrated the SSH server example into the main topic because we don't want an isolated sub-section within a main topic. 4. In the image features section of the ref-manual, I fixed the link with the "read-only-rootfs" feature to go to the now-isolated section on how to do that instead of going to the customizing an image using the IMAGE_FEATURES and EXTRA_IMAGE_FEATURES variables section. (From yocto-docs rev: 9c79b5f40d8dc6b37fbe636a2459f89b70bd8ea8) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 116 +++++++++--------- documentation/ref-manual/ref-features.xml | 6 +- documentation/ref-manual/ref-variables.xml | 50 ++++---- 3 files changed, 93 insertions(+), 79 deletions(-) diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 6ad61d633a..d65d73d59d 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -630,62 +630,30 @@ the Build Directory. -
- Choosing the SSH Server + + To illustrate how you can use these variables to modify your + image, consider an example that selects the SSH server. + The Yocto Project ships with two SSH servers you can use + with your images: Dropbear and OpenSSH. + Dropbear is a minimal SSH server appropriate for + resource-constrained environments, while OpenSSH is a + well-known standard SSH server implementation. + By default, the core-image-sato image + is configured to use Dropbear. + The core-image-basic and + core-image-lsb images both + include OpenSSH. + The core-image-minimal image does not + contain an SSH server. + - - The Yocto Project ships with two SSH servers you can use - with your images: Dropbear and OpenSSH. - Dropbear is a minimal SSH server appropriate for - resource-constrained environments, while OpenSSH is a - well-known standard SSH server implementation. - By default, the core-image-sato image - is configured to use Dropbear. - The core-image-basic and - core-image-lsb images both - include OpenSSH. - The core-image-minimal image does not - contain an SSH server. - - - - You can customize your image and change these defaults. - Edit IMAGE_FEATURES variable - so that it configures the image you are working with to - include ssh-server-dropbear or - ssh-server-openssh. - -
- -
- Creating a Read-Only Root Filesystem - - - Another example of customizing your image could be setting - up a read-only filesystem. - Suppose, for security reasons, you need to disable the - your target device's root filesystem's write permisions - (i.e. you need a read-only root filesystem). - Or, perhaps you are running the device's operating system - from a read-only storage device. - For either case, you can customize your image for - that behavior. - - - - To create a read-only root filesystem, simply add the - "read-only-rootfs" feature to your image. - Using either of the following statements in your - image recipe or from within the - local.conf file found in the Build - Directory causes the build system to create a - read-only root filesystem: - - IMAGE_FEATURES = "read-only-rootfs" - EXTRA_IMAGE_FEATURES = "read-only-rootfs" - - -
+ + You can customize your image and change these defaults. + Edit IMAGE_FEATURES variable + so that it configures the image you are working with to + include ssh-server-dropbear or + ssh-server-openssh. +
@@ -3447,6 +3415,44 @@
+
+ Creating a Read-Only Root Filesystem + + + Suppose, for security reasons, you need to disable the + your target device's root filesystem's write permisions + (i.e. you need a read-only root filesystem). + Or, perhaps you are running the device's operating system + from a read-only storage device. + For either case, you can customize your image for + that behavior. + + + + To create a read-only root filesystem, simply add the + "read-only-rootfs" feature to your image. + Using either of the following statements in your + image recipe or from within the + local.conf file found in the Build + Directory causes the build system to create a + read-only root filesystem: + + IMAGE_FEATURES = "read-only-rootfs" + EXTRA_IMAGE_FEATURES = "read-only-rootfs" + + + + + For more information on how to use these variables, see the + "Customizing Images Using Custom IMAGE_FEATURES and EXTRA_IMAGE_FEATURES" + section. + For information on the variables, see + IMAGE_FEATURES + and EXTRA_IMAGE_FEATURES. + +
+ +
Debugging With the GNU Project Debugger (GDB) Remotely diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml index 97c645149c..7c43ab392f 100644 --- a/documentation/ref-manual/ref-features.xml +++ b/documentation/ref-manual/ref-features.xml @@ -184,10 +184,10 @@ doc-pkgs: Installs documentation packages for all packages installed in a given image. nfs-server: Installs an NFS server. - read-only-fsroot: Creates + read-only-fsroot: Creates an image whose root filesystem is read-only. - See the - "Customizing Images Using Custom IMAGE_FEATURES and EXTRA_IMAGE_FEATURES" + See the + "Creating a Read-Only Root Filesystem" section in the Yocto Project Development Manual for more information. splash: Enables showing a splash screen during boot. diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index b954fd036a..f81ab62ded 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -950,12 +950,12 @@ Core layer for images cannot be removed The list of additional features to include in an image. Typically, you configure this variable in an image recipe. You can also configure it in the local.conf - file found in the + file found in the Build Directory. Use the IMAGE_FEATURES - variable to define the primary list of features you want to + variable to define the primary list of features you want to add to the image. @@ -967,12 +967,21 @@ Core layer for images cannot be removed including symbol information for debugging and profiling. +"debug-tweaks" - Makes an image suitable for development. + For example, ssh root access has a blank + password. You should remove this feature + before you produce a production image. + "dev-pkgs" - Adds -dev packages for all installed packages. This is useful if you want to develop against the libraries in the image. -"tools-sdk" - Adds development tools such as gcc, make, - pkgconfig and so forth. +"read-only-rootfs" - Creates an image whose root + filesystem is read-only. See the + "Creating a Read-Only Root Filesystem" + section in the Yocto Project + Development Manual for more + information "tools-debug" - Adds debugging tools such as gdb and strace. @@ -980,27 +989,26 @@ Core layer for images cannot be removed "tools-profile" - Adds profiling tools such as oprofile, exmap, lttng and valgrind (x86 only). +"tools-sdk" - Adds development tools such as gcc, make, + pkgconfig and so forth. + "tools-testapps" - Adds useful testing tools such as ts_print, aplay, arecord and so forth. -"debug-tweaks" - Makes an image suitable for development. - For example, ssh root access has a blank - password. You should remove this feature - before you produce a production image. - For a complete list of image features that ships with the - Yocto Project, see the - "Images" + For a complete list of image features that ships with the + Yocto Project, see the + "Images" section. - For some examples that show how to customize your image by - using this variable, see the + For some examples that show how to customize your image by + using this variable, see the "Customizing Images Using Custom IMAGE_FEATURES and EXTRA_IMAGE_FEATURES" section in the Yocto Project Development Manual. @@ -1229,23 +1237,23 @@ Core layer for images cannot be removed The list of features to include in an image. Typically, you configure this variable in an image recipe. - You can also configure it in the - local.conf file found in the + You can also configure it in the + local.conf file found in the Build Directory. - You can also add extra features to the image by using + You can also add extra features to the image by using the EXTRA_IMAGE_FEATURES variable. - For a list of image features that ships with the Yocto - Project, see the - "Images" + For a list of image features that ships with the Yocto + Project, see the + "Images" section. - For some examples that show how to customize your image by - using this variable, see the + For some examples that show how to customize your image by + using this variable, see the "Customizing Images Using Custom IMAGE_FEATURES and EXTRA_IMAGE_FEATURES" section in the Yocto Project Development Manual.