diff mbox series

bitbake-setup: add description of DL_DIR in default site.conf

Message ID 20251113-add-dl-dir-comments-v1-1-01fbda836324@bootlin.com
State New
Headers show
Series bitbake-setup: add description of DL_DIR in default site.conf | expand

Commit Message

Antonin Godard Nov. 13, 2025, 11:10 a.m. UTC
Add the comment from the local.conf.sample file in meta-poky to the
default site.conf file. It's a better experience for the user to have a
quick description of the variable when opening the file for the first
time.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Note this is a follow-up to Joshua's patch:
https://lore.kernel.org/r/20251112172619.3764053-1-JPEWhacker@gmail.com
---
 bin/bitbake-setup | 9 +++++++++
 1 file changed, 9 insertions(+)


---
base-commit: fd7960eded6228486e75d1c253b5c672b24f505c
change-id: 20251113-add-dl-dir-comments-8e93aae0a3f1
diff mbox series

Patch

diff --git a/bin/bitbake-setup b/bin/bitbake-setup
index 3a281defac..243c7c512b 100755
--- a/bin/bitbake-setup
+++ b/bin/bitbake-setup
@@ -683,6 +683,15 @@  def create_siteconf(top_dir, non_interactive, settings):
                 textwrap.dedent(
                     """\
                     # This file is intended for build host-specific bitbake settings
+
+                    # Where to place downloads
+                    #
+                    # During a first build the system will download many different source code
+                    # tarballs from various upstream projects. This can take a while, particularly
+                    # if your network connection is slow. These are all stored in DL_DIR. When
+                    # wiping and rebuilding you can preserve this directory to speed up this part of
+                    # subsequent builds. This directory is safe to share between multiple builds on
+                    # the same machine too.
                     DL_DIR = "{dl_dir}"
                     """.format(
                         dl_dir=settings["default"]["dl-dir"],