diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-04-03 08:51:38 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-04 14:13:45 +0100 |
commit | 6f6d0a59e3b6b8a75522d2918b98de735718f425 (patch) | |
tree | eba59b6dd8414398e1ae455ca2f84b585b92ba16 /documentation/ref-manual | |
parent | 9a98f403bd4f6fac7f88e43c820519dc9fc644b2 (diff) | |
download | poky-6f6d0a59e3b6b8a75522d2918b98de735718f425.tar.gz |
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 <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/ref-features.xml | 6 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 50 |
2 files changed, 32 insertions, 24 deletions
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 @@ | |||
184 | <listitem><para><emphasis>doc-pkgs:</emphasis> Installs documentation packages for all packages | 184 | <listitem><para><emphasis>doc-pkgs:</emphasis> Installs documentation packages for all packages |
185 | installed in a given image.</para></listitem> | 185 | installed in a given image.</para></listitem> |
186 | <listitem><para><emphasis>nfs-server:</emphasis> Installs an NFS server.</para></listitem> | 186 | <listitem><para><emphasis>nfs-server:</emphasis> Installs an NFS server.</para></listitem> |
187 | <listitem><para><emphasis>read-only-fsroot:</emphasis> Creates | 187 | <listitem><para><emphasis>read-only-fsroot:</emphasis> Creates |
188 | an image whose root filesystem is read-only. | 188 | an image whose root filesystem is read-only. |
189 | See the | 189 | See the |
190 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>" | 190 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>" |
191 | section in the Yocto Project Development Manual for more | 191 | section in the Yocto Project Development Manual for more |
192 | information.</para></listitem> | 192 | information.</para></listitem> |
193 | <listitem><para><emphasis>splash:</emphasis> Enables showing a splash screen during boot. | 193 | <listitem><para><emphasis>splash:</emphasis> 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 | |||
950 | The list of additional features to include in an image. | 950 | The list of additional features to include in an image. |
951 | Typically, you configure this variable in an image recipe. | 951 | Typically, you configure this variable in an image recipe. |
952 | You can also configure it in the <filename>local.conf</filename> | 952 | You can also configure it in the <filename>local.conf</filename> |
953 | file found in the | 953 | file found in the |
954 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 954 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
955 | <note> | 955 | <note> |
956 | Use the | 956 | Use the |
957 | <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> | 957 | <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> |
958 | variable to define the primary list of features you want to | 958 | variable to define the primary list of features you want to |
959 | add to the image. | 959 | add to the image. |
960 | </note> | 960 | </note> |
961 | </para> | 961 | </para> |
@@ -967,12 +967,21 @@ Core layer for images cannot be removed | |||
967 | including symbol information for debugging and | 967 | including symbol information for debugging and |
968 | profiling. | 968 | profiling. |
969 | 969 | ||
970 | "debug-tweaks" - Makes an image suitable for development. | ||
971 | For example, ssh root access has a blank | ||
972 | password. You should remove this feature | ||
973 | before you produce a production image. | ||
974 | |||
970 | "dev-pkgs" - Adds -dev packages for all installed packages. | 975 | "dev-pkgs" - Adds -dev packages for all installed packages. |
971 | This is useful if you want to develop against | 976 | This is useful if you want to develop against |
972 | the libraries in the image. | 977 | the libraries in the image. |
973 | 978 | ||
974 | "tools-sdk" - Adds development tools such as gcc, make, | 979 | "read-only-rootfs" - Creates an image whose root |
975 | pkgconfig and so forth. | 980 | filesystem is read-only. See the |
981 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>" | ||
982 | section in the Yocto Project | ||
983 | Development Manual for more | ||
984 | information | ||
976 | 985 | ||
977 | "tools-debug" - Adds debugging tools such as gdb and | 986 | "tools-debug" - Adds debugging tools such as gdb and |
978 | strace. | 987 | strace. |
@@ -980,27 +989,26 @@ Core layer for images cannot be removed | |||
980 | "tools-profile" - Adds profiling tools such as oprofile, | 989 | "tools-profile" - Adds profiling tools such as oprofile, |
981 | exmap, lttng and valgrind (x86 only). | 990 | exmap, lttng and valgrind (x86 only). |
982 | 991 | ||
992 | "tools-sdk" - Adds development tools such as gcc, make, | ||
993 | pkgconfig and so forth. | ||
994 | |||
983 | "tools-testapps" - Adds useful testing tools such as | 995 | "tools-testapps" - Adds useful testing tools such as |
984 | ts_print, aplay, arecord and so | 996 | ts_print, aplay, arecord and so |
985 | forth. | 997 | forth. |
986 | 998 | ||
987 | "debug-tweaks" - Makes an image suitable for development. | ||
988 | For example, ssh root access has a blank | ||
989 | password. You should remove this feature | ||
990 | before you produce a production image. | ||
991 | </literallayout> | 999 | </literallayout> |
992 | </para> | 1000 | </para> |
993 | 1001 | ||
994 | <para> | 1002 | <para> |
995 | For a complete list of image features that ships with the | 1003 | For a complete list of image features that ships with the |
996 | Yocto Project, see the | 1004 | Yocto Project, see the |
997 | "<link linkend="ref-features-image">Images</link>" | 1005 | "<link linkend="ref-features-image">Images</link>" |
998 | section. | 1006 | section. |
999 | </para> | 1007 | </para> |
1000 | 1008 | ||
1001 | <para> | 1009 | <para> |
1002 | For some examples that show how to customize your image by | 1010 | For some examples that show how to customize your image by |
1003 | using this variable, see the | 1011 | using this variable, see the |
1004 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>" | 1012 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>" |
1005 | section in the Yocto Project Development Manual. | 1013 | section in the Yocto Project Development Manual. |
1006 | </para> | 1014 | </para> |
@@ -1229,23 +1237,23 @@ Core layer for images cannot be removed | |||
1229 | <para> | 1237 | <para> |
1230 | The list of features to include in an image. | 1238 | The list of features to include in an image. |
1231 | Typically, you configure this variable in an image recipe. | 1239 | Typically, you configure this variable in an image recipe. |
1232 | You can also configure it in the | 1240 | You can also configure it in the |
1233 | <filename>local.conf</filename> file found in the | 1241 | <filename>local.conf</filename> file found in the |
1234 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 1242 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
1235 | <note> | 1243 | <note> |
1236 | You can also add extra features to the image by using | 1244 | You can also add extra features to the image by using |
1237 | the | 1245 | the |
1238 | <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. | 1246 | <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. |
1239 | </note> | 1247 | </note> |
1240 | For a list of image features that ships with the Yocto | 1248 | For a list of image features that ships with the Yocto |
1241 | Project, see the | 1249 | Project, see the |
1242 | "<link linkend="ref-features-image">Images</link>" | 1250 | "<link linkend="ref-features-image">Images</link>" |
1243 | section. | 1251 | section. |
1244 | </para> | 1252 | </para> |
1245 | 1253 | ||
1246 | <para> | 1254 | <para> |
1247 | For some examples that show how to customize your image by | 1255 | For some examples that show how to customize your image by |
1248 | using this variable, see the | 1256 | using this variable, see the |
1249 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>" | 1257 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>" |
1250 | section in the Yocto Project Development Manual. | 1258 | section in the Yocto Project Development Manual. |
1251 | </para> | 1259 | </para> |