summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-04-02 14:26:04 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-04 14:13:45 +0100
commit93b9efec114611985555757de84555ba7b498f19 (patch)
tree7ea3e01b38e8285878384ca60996200e27cfd6eb /documentation
parentc47dfebff69e5352a70a7a59c1a3ebd5ed36166e (diff)
downloadpoky-93b9efec114611985555757de84555ba7b498f19.tar.gz
dev-manual: First draft of new customizing images with features section.
I created two sub-sections in the original section. One covers how to customize the image by choosing the particular SSH server and the other has the new information on creating a read-only root filesystem. (From yocto-docs rev: a0ce1a2784f991b7c0871cbc0783e32dde37e314) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml75
1 files changed, 56 insertions, 19 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index b28b7e21ec..e6fd4fb363 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -630,25 +630,62 @@
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 <para> 633 <section id='choosing-the-ssh-servers'>
634 The Yocto Project ships with two SSH servers you can use in your 634 <title>Choosing the SSH Server</title>
635 images: Dropbear and OpenSSH. 635
636 Dropbear is a minimal SSH server appropriate for 636 <para>
637 resource-constrained environments, while OpenSSH is a well-known 637 The Yocto Project ships with two SSH servers you can use
638 standard SSH server implementation. 638 with your images: Dropbear and OpenSSH.
639 By default, the <filename>core-image-sato</filename> image is 639 Dropbear is a minimal SSH server appropriate for
640 configured to use Dropbear. 640 resource-constrained environments, while OpenSSH is a
641 The <filename>core-image-basic</filename> and 641 well-known standard SSH server implementation.
642 <filename>core-image-lsb</filename> images both 642 By default, the <filename>core-image-sato</filename> image
643 include OpenSSH. 643 is configured to use Dropbear.
644 The <filename>core-image-minimal</filename> image does not 644 The <filename>core-image-basic</filename> and
645 contain an SSH server. 645 <filename>core-image-lsb</filename> images both
646 To change these defaults, edit the 646 include OpenSSH.
647 <filename>IMAGE_FEATURES</filename> variable 647 The <filename>core-image-minimal</filename> image does not
648 so that it sets the image you are working with to include 648 contain an SSH server.
649 <filename>ssh-server-dropbear</filename> or 649 </para>
650 <filename>ssh-server-openssh</filename>. 650
651 </para> 651 <para>
652 You can customize your image and change these defaults.
653 Edit <filename>IMAGE_FEATURES</filename> variable
654 so that it configures the image you are working with to
655 include <filename>ssh-server-dropbear</filename> or
656 <filename>ssh-server-openssh</filename>.
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>
652 </section> 689 </section>
653 690
654 <section id='usingpoky-extend-customimage-localconf'> 691 <section id='usingpoky-extend-customimage-localconf'>