Skip to contentSkip to conversation

docs/manual: update pkg-kconfig doc about <pkg>-diff-config

PATCH New Marcel Patzlaff 2 participants 2 messages Aug 5, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/manual: update pkg-kconfig doc about <pkg>-diff-config

Briefly states what the output of this target is about.

---
 docs/manual/adding-packages-kconfig.txt | 5 +++++
 1 file changed, 5 insertions(+)
docs/manual/adding-packages-kconfig.txt +5 -0
index 982c1229ea..fa0bfd2b29 100644
@@ -43,6 +43,11 @@ This snippet creates the following make targets:
   options that differ from the default values. It is not possible to
   use this target when fragment files are set.
 
+* +foo-diff-config+, which outputs differences between the current
+  configuration and the one obtained by merging the defconfig with all set
+  configuration fragment files. The output is useful to identify entries
+  that are not yet in any configuration fragment file.
+
 and ensures that the source configuration file is copied to the build
 directory at the right moment.
 
Signature · 9 lines
2.17.1

Gesch?ftsf?hrung: Susanne Kunschert, Thomas Pilz
Pilz GmbH & Co. KG, Sitz: Ostfildern, HRA 210 893, Amtsgericht Stuttgart
Kompl. Ges. Peter Pilz GmbH, Sitz: Ostfildern, HRB 210 612, Amtsgericht Stuttgart
Umsatzsteuer: ID-Nr. DE 145 355 773, WEEE-Reg.-Nr. DE 71636849
This email is intended solely for the use of the named address(es). Any unauthorised disclosure, copying or distribution of these confidential information contained therein, or the taking of any action based on it, is prohibited. The sender disclaims any liability for the integrity of this email. Legally binding declarations must be in written form.
Umweltschutz liegt uns am Herzen! - Bitte denken Sie an unsere Umwelt, bevor Sie diese E-Mail drucken.
We do care about the environment! - Please consider the environment before printing this e-mail.
#1 lore raw

PATCH 1/1 docs/manual: update pkg-kconfig doc about <pkg>-diff-config

Hello,

Quoted 12 lines · On Mon, 5 Aug 2019 08:43:01 +0200 Marcel Patzlaff <[email protected]> wrote:

Briefly states what the output of this target is about.

---
 docs/manual/adding-packages-kconfig.txt | 5 +++++
 1 file changed, 5 insertions(+)
docs/manual/adding-packages-kconfig.txt +0 -0
index 982c1229ea..fa0bfd2b29 100644

docs/manual/adding-packages-kconfig.txt This snippet creates the following make targets: · line 48

Quoted 6 lines
docs/manual/adding-packages-kconfig.txt +3 -0
@@ -43,6 +43,11 @@ This snippet creates the following make targets:
   options that differ from the default values. It is not possible to
   use this target when fragment files are set.
 
+* +foo-diff-config+, which outputs differences between the current
+  configuration and the one obtained by merging the defconfig with all set
+  configuration fragment files. The output is useful to identify entries

In fact the configuration may not come from a defconfig + fragments, it may also come from a full configuration file.

docs/manual/adding-packages-kconfig.txt This snippet creates the following make targets: · line 49

Quoted 1 line
docs/manual/adding-packages-kconfig.txt +1 -0
+  that are not yet in any configuration fragment file.

I've slightly reworded this, and applied.

One thing that bothers me a bit is that these make targets are really useful to the Buildroot user, but their documentation is buried inside the kconfig-package infrastructure documentation, which is unlikely to be read. But this is not your fault, other kconfig-specific make targets were documented here. It just shows that our documentation is not as well-structured as it should be.

Another thing: could you write a test case in support/testing/ for this pkg-diff-config feature ? Indeed, it is not a feature tested automatically by our autobuilders, so it would be nice to exercise it through an explicit test in support/testing.

Thanks!

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com