summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/features.rst
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-12-20 13:16:35 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-12-28 10:57:47 +0000
commitabef9b08dc1e8de7c4088d982641a2784b98f378 (patch)
treeea32f4068107dc2bea17d2001e88120884eec37a /documentation/ref-manual/features.rst
parente4c4208d126c133f8b36b6add5d917830237d5bc (diff)
downloadpoky-abef9b08dc1e8de7c4088d982641a2784b98f378.tar.gz
Remove debug-tweaks references
We no longer provide this feature, so remove documentation for it. In most cases, we can replace occurrences of "debug-tweaks" by "allow-empty-password empty-root-password allow-root-login post-install-logging" to achieve what this feature previously enabled. Subtle, but the default local.conf does not include post-install-logging, so in parts where there is mention of the default local.conf file, adjust the documentation to only mention the first three above. In the intro manual, instead of providing instructions that replace EXTRA_IMAGE_FEATURES entirely, provide ones that append EXTRA_IMAGE_FEATURES. (From yocto-docs rev: f0efd4c7df91863304b92514664bdd1fa62b1fbb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/features.rst')
-rw-r--r--documentation/ref-manual/features.rst19
1 files changed, 6 insertions, 13 deletions
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.