diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/build-quality.rst | 2 | ||||
-rw-r--r-- | documentation/dev-manual/customizing-images.rst | 3 | ||||
-rw-r--r-- | documentation/dev-manual/securing-images.rst | 12 | ||||
-rw-r--r-- | documentation/profile-manual/intro.rst | 4 | ||||
-rw-r--r-- | documentation/profile-manual/usage.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/features.rst | 19 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 12 | ||||
-rw-r--r-- | documentation/sdk-manual/extensible.rst | 5 |
8 files changed, 29 insertions, 30 deletions
diff --git a/documentation/dev-manual/build-quality.rst b/documentation/dev-manual/build-quality.rst index 713ea3a48e..fbe5fb6f0b 100644 --- a/documentation/dev-manual/build-quality.rst +++ b/documentation/dev-manual/build-quality.rst | |||
@@ -236,7 +236,7 @@ Here is an example of ``image-info.txt``: | |||
236 | DISTRO_VERSION = 3.4+snapshot-a0245d7be08f3d24ea1875e9f8872aa6bbff93be | 236 | DISTRO_VERSION = 3.4+snapshot-a0245d7be08f3d24ea1875e9f8872aa6bbff93be |
237 | USER_CLASSES = buildstats | 237 | USER_CLASSES = buildstats |
238 | IMAGE_CLASSES = qemuboot qemuboot license_image | 238 | IMAGE_CLASSES = qemuboot qemuboot license_image |
239 | IMAGE_FEATURES = debug-tweaks | 239 | IMAGE_FEATURES = allow-empty-password empty-root-password allow-root-login post-install-logging |
240 | IMAGE_LINGUAS = | 240 | IMAGE_LINGUAS = |
241 | IMAGE_INSTALL = packagegroup-core-boot speex speexdsp | 241 | IMAGE_INSTALL = packagegroup-core-boot speex speexdsp |
242 | BAD_RECOMMENDATIONS = | 242 | BAD_RECOMMENDATIONS = |
diff --git a/documentation/dev-manual/customizing-images.rst b/documentation/dev-manual/customizing-images.rst index 5b18958ade..6348259446 100644 --- a/documentation/dev-manual/customizing-images.rst +++ b/documentation/dev-manual/customizing-images.rst | |||
@@ -62,8 +62,7 @@ To understand how these features work, the best reference is | |||
62 | :ref:`meta/classes-recipe/image.bbclass <ref-classes-image>`. | 62 | :ref:`meta/classes-recipe/image.bbclass <ref-classes-image>`. |
63 | This class lists out the available | 63 | This class lists out the available |
64 | :term:`IMAGE_FEATURES` of which most map to package groups while some, such | 64 | :term:`IMAGE_FEATURES` of which most map to package groups while some, such |
65 | as ``debug-tweaks`` and ``read-only-rootfs``, resolve as general | 65 | as ``read-only-rootfs``, resolve as general configuration settings. |
66 | configuration settings. | ||
67 | 66 | ||
68 | In summary, the file looks at the contents of the :term:`IMAGE_FEATURES` | 67 | In summary, the file looks at the contents of the :term:`IMAGE_FEATURES` |
69 | variable and then maps or configures the feature accordingly. Based on | 68 | variable and then maps or configures the feature accordingly. Based on |
diff --git a/documentation/dev-manual/securing-images.rst b/documentation/dev-manual/securing-images.rst index e5791d3d6d..f4b528e559 100644 --- a/documentation/dev-manual/securing-images.rst +++ b/documentation/dev-manual/securing-images.rst | |||
@@ -107,18 +107,18 @@ Considerations Specific to the OpenEmbedded Build System | |||
107 | You can take some steps that are specific to the OpenEmbedded build | 107 | You can take some steps that are specific to the OpenEmbedded build |
108 | system to make your images more secure: | 108 | system to make your images more secure: |
109 | 109 | ||
110 | - Ensure "debug-tweaks" is not one of your selected | 110 | - Ensure that "allow-empty-password", "allow-root-login", or |
111 | :term:`IMAGE_FEATURES`. | 111 | "empty-root-password" are not one of your selected :term:`IMAGE_FEATURES`. |
112 | When creating a new project, the default is to provide you with an | 112 | When creating a new project, the default is to provide you with an |
113 | initial ``local.conf`` file that enables this feature using the | 113 | initial ``local.conf`` file that enables these features using the |
114 | :term:`EXTRA_IMAGE_FEATURES` | 114 | :term:`EXTRA_IMAGE_FEATURES` |
115 | variable with the line:: | 115 | variable with the line:: |
116 | 116 | ||
117 | EXTRA_IMAGE_FEATURES = "debug-tweaks" | 117 | EXTRA_IMAGE_FEATURES = "allow-empty-password empty-root-password allow-root-login" |
118 | 118 | ||
119 | To disable that feature, simply comment out that line in your | 119 | To disable these features, simply comment out that line in your |
120 | ``local.conf`` file, or make sure :term:`IMAGE_FEATURES` does not contain | 120 | ``local.conf`` file, or make sure :term:`IMAGE_FEATURES` does not contain |
121 | "debug-tweaks" before producing your final image. Among other things, | 121 | any of these features before producing your final image. Among other things, |
122 | leaving this in place sets the root password as blank, which makes | 122 | leaving this in place sets the root password as blank, which makes |
123 | logging in for debugging or inspection easy during development but | 123 | logging in for debugging or inspection easy during development but |
124 | also means anyone can easily log in during production. | 124 | also means anyone can easily log in during production. |
diff --git a/documentation/profile-manual/intro.rst b/documentation/profile-manual/intro.rst index 86310cf318..3179125524 100644 --- a/documentation/profile-manual/intro.rst +++ b/documentation/profile-manual/intro.rst | |||
@@ -43,7 +43,7 @@ an ``sdk`` image, perhaps one of:: | |||
43 | Alternatively, you can add ``tools-profile`` to the :term:`EXTRA_IMAGE_FEATURES` line in | 43 | Alternatively, you can add ``tools-profile`` to the :term:`EXTRA_IMAGE_FEATURES` line in |
44 | your ``local.conf`` file:: | 44 | your ``local.conf`` file:: |
45 | 45 | ||
46 | EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile" | 46 | EXTRA_IMAGE_FEATURES:append = " tools-profile" |
47 | 47 | ||
48 | If you use the ``tools-profile`` method, you don't need to build an sdk image --- | 48 | If you use the ``tools-profile`` method, you don't need to build an sdk image --- |
49 | the tracing and profiling tools will be included in non-sdk images as well e.g.:: | 49 | the tracing and profiling tools will be included in non-sdk images as well e.g.:: |
@@ -69,7 +69,7 @@ packages (xxx-dbg) which you can manually install as needed. | |||
69 | To generate debug info for packages, you can add ``dbg-pkgs`` to | 69 | To generate debug info for packages, you can add ``dbg-pkgs`` to |
70 | :term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example:: | 70 | :term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example:: |
71 | 71 | ||
72 | EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs" | 72 | EXTRA_IMAGE_FEATURES:append = " dbg-pkgs" |
73 | 73 | ||
74 | Additionally, in order to generate the right type of debug info, we also need to | 74 | Additionally, in order to generate the right type of debug info, we also need to |
75 | set :term:`PACKAGE_DEBUG_SPLIT_STYLE` in the ``local.conf`` file:: | 75 | set :term:`PACKAGE_DEBUG_SPLIT_STYLE` in the ``local.conf`` file:: |
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 17be149580..d17b256d0f 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst | |||
@@ -308,7 +308,7 @@ install the debugging information for the BusyBox package. | |||
308 | To generate the debug info for the packages in the image, we can add | 308 | To generate the debug info for the packages in the image, we can add |
309 | ``dbg-pkgs`` to :term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example:: | 309 | ``dbg-pkgs`` to :term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example:: |
310 | 310 | ||
311 | EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs" | 311 | EXTRA_IMAGE_FEATURES:append = " dbg-pkgs" |
312 | 312 | ||
313 | Additionally, in order to generate the type of debugging information that perf | 313 | Additionally, in order to generate the type of debugging information that perf |
314 | understands, we also need to set :term:`PACKAGE_DEBUG_SPLIT_STYLE` | 314 | understands, we also need to set :term:`PACKAGE_DEBUG_SPLIT_STYLE` |
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst index 6e52dfce17..4d327f1a7d 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst | |||
@@ -285,31 +285,24 @@ The image features available for all images are: | |||
285 | - *dbg-pkgs:* Installs debug symbol packages for all packages installed | 285 | - *dbg-pkgs:* Installs debug symbol packages for all packages installed |
286 | in a given image. | 286 | in a given image. |
287 | 287 | ||
288 | - *debug-tweaks:* Makes an image suitable for development (e.g. allows | ||
289 | root logins, logins without passwords ---including root ones, and enables | ||
290 | post-installation logging). See the ``allow-empty-password``, | ||
291 | ``allow-root-login``, ``empty-root-password``, and ``post-install-logging`` | ||
292 | features in this list for additional information. | ||
293 | |||
294 | - *dev-pkgs:* Installs development packages (headers and extra library | 288 | - *dev-pkgs:* Installs development packages (headers and extra library |
295 | links) for all packages installed in a given image. | 289 | links) for all packages installed in a given image. |
296 | 290 | ||
297 | - *doc-pkgs:* Installs documentation packages for all packages | 291 | - *doc-pkgs:* Installs documentation packages for all packages |
298 | installed in a given image. | 292 | installed in a given image. |
299 | 293 | ||
300 | - *empty-root-password:* This feature or ``debug-tweaks`` is required if | 294 | - *empty-root-password:* This feature can be used if you want to allow root |
301 | you want to allow root login with an empty password. If these features | 295 | login with an empty password. If this feature is not present in |
302 | are not present in :term:`IMAGE_FEATURES`, a non-empty password is | 296 | :term:`IMAGE_FEATURES`, a non-empty password is forced in ``/etc/passwd`` and |
303 | forced in ``/etc/passwd`` and ``/etc/shadow`` if such files exist. | 297 | ``/etc/shadow`` if such files exist. |
304 | 298 | ||
305 | .. note:: | 299 | .. note:: |
306 | ``empty-root-password`` doesn't set an empty root password by itself. | 300 | ``empty-root-password`` doesn't set an empty root password by itself. |
307 | You get an initial empty root password thanks to the | 301 | You get an initial empty root password thanks to the |
308 | :oe_git:`base-passwd </openembedded-core/tree/meta/recipes-core/base-passwd/>` | 302 | :oe_git:`base-passwd </openembedded-core/tree/meta/recipes-core/base-passwd/>` |
309 | and :oe_git:`shadow </openembedded-core/tree/meta/recipes-extended/shadow/>` | 303 | and :oe_git:`shadow </openembedded-core/tree/meta/recipes-extended/shadow/>` |
310 | recipes, and the presence of ``empty-root-password`` or ``debug-tweaks`` | 304 | recipes, and the presence of ``empty-root-password`` just disables the |
311 | just disables the mechanism which forces an non-empty password for the | 305 | mechanism which forces an non-empty password for the root user. |
312 | root user. | ||
313 | 306 | ||
314 | - *lic-pkgs:* Installs license packages for all packages installed in a | 307 | - *lic-pkgs:* Installs license packages for all packages installed in a |
315 | given image. | 308 | given image. |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 89c37729bd..5d24e80865 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -2604,10 +2604,14 @@ system and gives an overview of their function and contents. | |||
2604 | - "dbg-pkgs" --- adds -dbg packages for all installed packages including | 2604 | - "dbg-pkgs" --- adds -dbg packages for all installed packages including |
2605 | symbol information for debugging and profiling. | 2605 | symbol information for debugging and profiling. |
2606 | 2606 | ||
2607 | - "debug-tweaks" --- makes an image suitable for debugging. For example, allows root logins without passwords and | 2607 | - "empty-root-password" --- This feature can be used if you want to |
2608 | enables post-installation logging. See the 'allow-empty-password' and | 2608 | allow root login with an empty password. |
2609 | 'post-install-logging' features in the ":ref:`ref-features-image`" | 2609 | - "allow-empty-password" --- Allows Dropbear and OpenSSH to accept |
2610 | section for more information. | 2610 | logins from accounts having an empty password string. |
2611 | - "allow-root-login" --- Allows Dropbear and OpenSSH to accept root logins. | ||
2612 | - "post-install-logging" --- Enables logging postinstall script runs to | ||
2613 | the ``/var/log/postinstall.log`` file on first boot of the image on | ||
2614 | the target system. | ||
2611 | - "dev-pkgs" --- adds -dev packages for all installed packages. This is | 2615 | - "dev-pkgs" --- adds -dev packages for all installed packages. This is |
2612 | useful if you want to develop against the libraries in the image. | 2616 | useful if you want to develop against the libraries in the image. |
2613 | - "read-only-rootfs" --- creates an image whose root filesystem is | 2617 | - "read-only-rootfs" --- creates an image whose root filesystem is |
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index 3f6a754d88..9a50d7fc54 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst | |||
@@ -655,7 +655,10 @@ The extensible SDK supports two different development modes. | |||
655 | # SSH is mandatory, no password simplifies the usage | 655 | # SSH is mandatory, no password simplifies the usage |
656 | EXTRA_IMAGE_FEATURES += "\ | 656 | EXTRA_IMAGE_FEATURES += "\ |
657 | ssh-server-openssh \ | 657 | ssh-server-openssh \ |
658 | debug-tweaks \ | 658 | allow-empty-password \ |
659 | allow-root-login \ | ||
660 | empty-root-password \ | ||
661 | post-install-logging \ | ||
659 | " | 662 | " |
660 | 663 | ||
661 | # Remote debugging needs gdbserver on the target device | 664 | # Remote debugging needs gdbserver on the target device |