summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2018-10-03 07:19:43 +0200
committerUlf Magnusson <ulfalizer@gmail.com>2018-10-03 08:05:59 +0200
commit4602028ba2450903b63f043377cc63ac5e5e36de (patch)
treef2c734d090adcd8e3bf3949530566af2e14ef9d6 /README.rst
parentabd08a0cb52db13c6c6403d5a3793c2fa0e062b6 (diff)
genconfig: Allow writing a full .config without incremental build info
For projects that don't use incremental build information, it's a bit wasteful to generate it just to get an updated .config file to include in Makefiles. Add a '--config-out <filename>' option that just writes the updated .config file, for those cases. Also remove a redundant default=None argument for --sync-deps. None is the default value.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst17
1 files changed, 10 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 3c38839..44763be 100644
--- a/README.rst
+++ b/README.rst
@@ -121,7 +121,7 @@ Getting started
3. Generate an initial configuration with e.g. ``menuconfig`` or
``alldefconfig``. The configuration is saved as ``.config`` by default.
-4. Run ``genconfig`` to generate a header file. By default, it is saved in
+4. Run ``genconfig`` to generate a header file. By default, it is saved as
``config.h``.
Normally, ``genconfig`` would be run automatically as part of the build.
@@ -146,12 +146,15 @@ read configuration values from there. This is why ``n``-valued ``bool``/``trista
values are written out as ``# CONFIG_FOO is not set`` (a Make comment) in ``.config``
(allowing them to be tested with ``ifdef`` in Make).
-If you make use of this, you might want to pass ``--sync-deps`` to
-``genconfig`` and include ``deps/auto.conf`` in your Makefiles instead of
-including ``.config`` directly. This has the advantage that ``deps/auto.conf``
-will always be a "full" configuration file, even if ``.config`` is outdated.
-Otherwise, it might be necessary to run ``old(def)config`` or ``menuconfig``
-before rebuilding with an outdated configuration.
+If you make use of this, you might want to pass ``--config-out <filename>`` to
+``genconfig`` and include the generated configuration file instead of including
+``.config`` directly. This has the advantage that the generated configuration
+file will always be a "full" configuration file, even if ``.config`` is
+outdated. Otherwise, it might be necessary to run ``old(def)config`` or
+``menuconfig`` before rebuilding with an outdated ``.config``.
+
+If you use ``--sync-deps`` to generate incremental build information, you can
+include ``deps/auto.conf`` instead, which is also a full configuration file.
Library documentation
---------------------