diff mbox series

[1/1] docs/manual/customize-configuration.adoc: warn and give workaround for surprising `make savedefconfig` behavior in some cases

Message ID PH0PR17MB5727DE48E5AF3DD83CDAB0F8B7192@PH0PR17MB5727.namprd17.prod.outlook.com
State New
Headers show
Series [1/1] docs/manual/customize-configuration.adoc: warn and give workaround for surprising `make savedefconfig` behavior in some cases | expand

Commit Message

Barrie Slaymaker \(he/him\) Jan. 15, 2025, 10:07 p.m. UTC 
The documentation does not mention a behavior that happens when using, then saving e.g. configs/pc_x86_64_efi_defconfig. This behavior can silently "corrupt" a built-in defconfig by adding in a user's changes, so at least a warning should be given.

Signed-off-by: Barrie Slaymaker <barries@iotamotion.com>
---
 docs/manual/customize-configuration.adoc | 6 ++++++
 1 file changed, 6 insertions(+)

https://lists.buildroot.org/mailman/listinfo/buildroot
diff mbox series

Patch

diff --git a/docs/manual/customize-configuration.adoc b/docs/manual/customize-configuration.adoc
index fa8f4546..b1be5f17 100644
--- a/docs/manual/customize-configuration.adoc
+++ b/docs/manual/customize-configuration.adoc
@@ -13,6 +13,12 @@  called +defconfig+. If you want to save it in another place, change the  +BR2_DEFCONFIG+ option in the Buildroot configuration itself, or call  make with +make savedefconfig BR2_DEFCONFIG=<path-to-defconfig>+.

+NOTE: A few of the files in +configs+ set +BR2_DEFCONFIG+. This causes
++make <boardname>_defconfig+ followed by +make savedefconfig+ to
+overwrite the original +configs/<boardname>_defconfig+ instead of 
+writing +defconfig+. To prevent this, either unset +BR2_DEFCONFIG+ in 
+your `.config`, or run +make savedefconfig BR2_DEFCONFIG=defconfig+.
+
 The recommended place to store this defconfig is  +configs/<boardname>_defconfig+. If you follow this recommendation, the  configuration will be listed in +make list-defconfigs+ and can be set
--
2.34.1
_______________________________________________
buildroot mailing list
buildroot@buildroot.org