[PATCH v2 27/27] qconfig: Update the documentation

[Simon Glass]

Hi Heinrich,

On Thu, 14 Sept 2023 at 20:39, Heinrich Schuchardt <xypron.glpk at gmx.de> wrote:
>
>
>
> Am 15. September 2023 02:22:29 MESZ schrieb Simon Glass <sjg at chromium.org>:
> >Update qconfig's documentation to better reflect its new purpose in life.
> >
> >Signed-off-by: Simon Glass <sjg at chromium.org>
> >---
> >
> >Changes in v2:
> >- Reinstate the -C option
> >
> > doc/develop/index.rst                       |   2 +-
> > doc/develop/{moveconfig.rst => qconfig.rst} | 144 +++++---------------
> > 2 files changed, 38 insertions(+), 108 deletions(-)
> > rename doc/develop/{moveconfig.rst => qconfig.rst} (61%)
> >
> >diff --git a/doc/develop/index.rst b/doc/develop/index.rst
> >index 0d12484ace8a..003cdfccf112 100644
> >--- a/doc/develop/index.rst
> >+++ b/doc/develop/index.rst
> >@@ -88,7 +88,7 @@ Refactoring
> >
> >    checkpatch
> >    coccinelle
> >-   moveconfig
> >+   qconfig
> >
> > Code quality
> > ------------
> >diff --git a/doc/develop/moveconfig.rst b/doc/develop/qconfig.rst
> >similarity index 61%
> >rename from doc/develop/moveconfig.rst
> >rename to doc/develop/qconfig.rst
> >index ad8596e6c61a..111e2b2545d9 100644
> >--- a/doc/develop/moveconfig.rst
> >+++ b/doc/develop/qconfig.rst
> >@@ -1,100 +1,37 @@
> > .. SPDX-License-Identifier: GPL-2.0+
> >
> >-moveconfig - Migrating and querying CONFIG options
> >-==================================================
> >+qconfig - Querying CONFIG options
> >+=================================
> >
> >-Since Kconfig was introduced to U-Boot, we have worked on moving
> >-config options from headers to Kconfig (defconfig).
> >+It is not possible to see all the CONFIG options used by a board without
> >+building its `.config` file. This tool allowing this to be done efficiently for
>
> %s/allowing/allows/
>
>
> >+all boards, or a subset, writing the results to a unified database file.
> >
> >-This tool intends to help this tremendous work.
> >+This database can be queried, to find boards which used a certain combination
> >+of options, to aid in discovering Kconfig options which imply others.
> >+
> >+The tool also permits syncing of defconfigs, which corrects the ordering and
>
> %s/syncing/synchronizing/
>

Thanks for going through this. I have updated everything except for
the syncing bit, since that is English these days.

Regards,
Simon