diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 118 | ||||
-rw-r--r-- | documentation/ref-manual/ref-features.xml | 6 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 50 |
3 files changed, 94 insertions, 80 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 @@ | |||
630 | the <link linkend='build-directory'>Build Directory</link>. | 630 | the <link linkend='build-directory'>Build Directory</link>. |
631 | </para> | 631 | </para> |
632 | 632 | ||
633 | <section id='choosing-the-ssh-servers'> | 633 | <para> |
634 | <title>Choosing the SSH Server</title> | 634 | To illustrate how you can use these variables to modify your |
635 | 635 | image, consider an example that selects the SSH server. | |
636 | <para> | 636 | The Yocto Project ships with two SSH servers you can use |
637 | The Yocto Project ships with two SSH servers you can use | 637 | with your images: Dropbear and OpenSSH. |
638 | with your images: Dropbear and OpenSSH. | 638 | Dropbear is a minimal SSH server appropriate for |
639 | Dropbear is a minimal SSH server appropriate for | 639 | resource-constrained environments, while OpenSSH is a |
640 | resource-constrained environments, while OpenSSH is a | 640 | well-known standard SSH server implementation. |
641 | well-known standard SSH server implementation. | 641 | By default, the <filename>core-image-sato</filename> image |
642 | By default, the <filename>core-image-sato</filename> image | 642 | is configured to use Dropbear. |
643 | is configured to use Dropbear. | 643 | The <filename>core-image-basic</filename> and |
644 | The <filename>core-image-basic</filename> and | 644 | <filename>core-image-lsb</filename> images both |
645 | <filename>core-image-lsb</filename> images both | 645 | include OpenSSH. |
646 | include OpenSSH. | 646 | The <filename>core-image-minimal</filename> image does not |
647 | The <filename>core-image-minimal</filename> image does not | 647 | contain an SSH server. |
648 | contain an SSH server. | 648 | </para> |
649 | </para> | 649 | |
650 | 650 | <para> | |
651 | <para> | 651 | You can customize your image and change these defaults. |
652 | You can customize your image and change these defaults. | 652 | Edit <filename>IMAGE_FEATURES</filename> variable |
653 | Edit <filename>IMAGE_FEATURES</filename> variable | 653 | so that it configures the image you are working with to |
654 | so that it configures the image you are working with to | 654 | include <filename>ssh-server-dropbear</filename> or |
655 | include <filename>ssh-server-dropbear</filename> or | 655 | <filename>ssh-server-openssh</filename>. |
656 | <filename>ssh-server-openssh</filename>. | 656 | </para> |
657 | </para> | ||
658 | </section> | ||
659 | |||
660 | <section id='creating-a-read-only-root-filesystem'> | ||
661 | <title>Creating a Read-Only Root Filesystem</title> | ||
662 | |||
663 | <para> | ||
664 | Another example of customizing your image could be setting | ||
665 | up a read-only filesystem. | ||
666 | Suppose, for security reasons, you need to disable the | ||
667 | your target device's root filesystem's write permisions | ||
668 | (i.e. you need a read-only root filesystem). | ||
669 | Or, perhaps you are running the device's operating system | ||
670 | from a read-only storage device. | ||
671 | For either case, you can customize your image for | ||
672 | that behavior. | ||
673 | </para> | ||
674 | |||
675 | <para> | ||
676 | To create a read-only root filesystem, simply add the | ||
677 | "read-only-rootfs" feature to your image. | ||
678 | Using either of the following statements in your | ||
679 | image recipe or from within the | ||
680 | <filename>local.conf</filename> file found in the Build | ||
681 | Directory causes the build system to create a | ||
682 | read-only root filesystem: | ||
683 | <literallayout class='monospaced'> | ||
684 | IMAGE_FEATURES = "read-only-rootfs" | ||
685 | EXTRA_IMAGE_FEATURES = "read-only-rootfs" | ||
686 | </literallayout> | ||
687 | </para> | ||
688 | </section> | ||
689 | </section> | 657 | </section> |
690 | 658 | ||
691 | <section id='usingpoky-extend-customimage-localconf'> | 659 | <section id='usingpoky-extend-customimage-localconf'> |
@@ -3447,6 +3415,44 @@ | |||
3447 | </para> | 3415 | </para> |
3448 | </section> | 3416 | </section> |
3449 | 3417 | ||
3418 | <section id='creating-a-read-only-root-filesystem'> | ||
3419 | <title>Creating a Read-Only Root Filesystem</title> | ||
3420 | |||
3421 | <para> | ||
3422 | Suppose, for security reasons, you need to disable the | ||
3423 | your target device's root filesystem's write permisions | ||
3424 | (i.e. you need a read-only root filesystem). | ||
3425 | Or, perhaps you are running the device's operating system | ||
3426 | from a read-only storage device. | ||
3427 | For either case, you can customize your image for | ||
3428 | that behavior. | ||
3429 | </para> | ||
3430 | |||
3431 | <para> | ||
3432 | To create a read-only root filesystem, simply add the | ||
3433 | "read-only-rootfs" feature to your image. | ||
3434 | Using either of the following statements in your | ||
3435 | image recipe or from within the | ||
3436 | <filename>local.conf</filename> file found in the Build | ||
3437 | Directory causes the build system to create a | ||
3438 | read-only root filesystem: | ||
3439 | <literallayout class='monospaced'> | ||
3440 | IMAGE_FEATURES = "read-only-rootfs" | ||
3441 | EXTRA_IMAGE_FEATURES = "read-only-rootfs" | ||
3442 | </literallayout> | ||
3443 | </para> | ||
3444 | |||
3445 | <para> | ||
3446 | For more information on how to use these variables, see the | ||
3447 | "<link linkend='usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></link>" | ||
3448 | section. | ||
3449 | For information on the variables, see | ||
3450 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink> | ||
3451 | and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>. | ||
3452 | </para> | ||
3453 | </section> | ||
3454 | |||
3455 | |||
3450 | <section id="platdev-gdb-remotedebug"> | 3456 | <section id="platdev-gdb-remotedebug"> |
3451 | <title>Debugging With the GNU Project Debugger (GDB) Remotely</title> | 3457 | <title>Debugging With the GNU Project Debugger (GDB) Remotely</title> |
3452 | 3458 | ||
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> |