From a9c7f1f50e5420ba5e5f250c4ab8acaf2837d99f Mon Sep 17 00:00:00 2001 From: "Yann E. MORIN" Date: Sat, 21 Sep 2024 18:32:58 +0200 Subject: [PATCH] docs/manual: do not instruct doctoring the saved defconfig Doctoring a defconfig is tedious, and it is not easy to update a defconfig, as it requires manual copy-pasting, adding comments and so on... Instead, just require defconfigs to be generated with 'savedefconfig'. Any details can/must be provided in the commit log. Reported-by: Edgar Bonet Signed-off-by: Yann E. MORIN Signed-off-by: Arnout Vandecappelle (cherry picked from commit 17bdd10cb350e9c45926c2a5a05f278d104ee4c9) Signed-off-by: Peter Korsgaard --- docs/manual/adding-board-support.adoc | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/manual/adding-board-support.adoc b/docs/manual/adding-board-support.adoc index be7699668d..0f7d534603 100644 --- a/docs/manual/adding-board-support.adoc +++ b/docs/manual/adding-board-support.adoc @@ -22,11 +22,7 @@ selections are highly application-specific. Once you have a known working configuration, run +make savedefconfig+. This will generate a minimal +defconfig+ file at the root of the Buildroot source tree. Move this file into the +configs/+ -directory, and rename it +_defconfig+. If the configuration -is a bit more complicated, it is nice to manually reformat it and -separate it into sections, with a comment before each section. Typical -sections are _Architecture_, _Toolchain options_ (typically just linux -headers version), _Firmware_, _Bootloader_, _Kernel_, and _Filesystem_. +directory, and rename it +_defconfig+. Always use fixed versions or commit hashes for the different components, not the "latest" version. For example, set