diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 118 |
1 files changed, 62 insertions, 56 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 | ||