From: Daan De Meyer <daan.j.demeyer@gmail.com>
Date: Sun, 22 Oct 2023 09:51:50 +0000 (+0200)
Subject: Enable WithDocs= by default
X-Git-Tag: v19~56
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=63dcc6e7fb9eeeb11a593a9cb0c67f8bcee5ec02;p=thirdparty%2Fmkosi.git

Enable WithDocs= by default

Let's include documentation by default so as to not confuse users.
---

diff --git a/NEWS.md b/NEWS.md
index a6bb7cb02..aabe8b62e 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -23,6 +23,7 @@
   the default tools tree
 - We now make sure git can be executed from mkosi scripts without
   running into permission errors
+- `WithDocs=` is now enabled by default.
 
 ## v18
 
diff --git a/mkosi/config.py b/mkosi/config.py
index fb92d5bdb..3e7428c54 100644
--- a/mkosi/config.py
+++ b/mkosi/config.py
@@ -1288,6 +1288,7 @@ SETTINGS = (
         nargs="?",
         section="Content",
         parse=config_parse_boolean,
+        default=True,
         help="Install documentation",
     ),
     MkosiConfigSetting(
diff --git a/mkosi/resources/mkosi.md b/mkosi/resources/mkosi.md
index 9f0020e3c..94485125a 100644
--- a/mkosi/resources/mkosi.md
+++ b/mkosi/resources/mkosi.md
@@ -708,11 +708,11 @@ boolean argument: either `1`, `yes`, or `true` to enable, or `0`, `no`,
 
 `WithDocs=`, `--with-docs`
 
-: Include documentation in the image built. By default if the
-  underlying distribution package manager supports it documentation is
-  not included in the image built. The `$WITH_DOCS` environment
-  variable passed to the `mkosi.build` scripts indicates whether this
-  option was used or not.
+: Include documentation in the image. Enabled by default. When disabled,
+  if the underlying distribution package manager supports it
+  documentation is not included in the image. The `$WITH_DOCS`
+  environment variable passed to the `mkosi.build` scripts is set to `0`
+  or `1` depending on whether this option is enabled or disabled.
 
 `BaseTrees=`, `--base-tree=`