summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2018-10-12 23:51:37 +0200
committerUlf Magnusson <ulfalizer@gmail.com>2018-10-13 00:23:34 +0200
commitbde4cc71fc01f209e1df0916843d351be201f78e (patch)
tree238dc144f0f1d75e44f42d6165679ab4443540e0 /README.rst
parent9b09e2b72e4214cc48ddad6c9b33dbe59f59c7ce (diff)
Add some hints re. generating custom configuration output
It's not obvious that Symbol.config_string can be useful even when generating other output formats, as it provides a hook for _write_to_conf. Mention it in the 'config_string' documentation and in relevant parts of the README.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index dc3dc2c..a893434 100644
--- a/README.rst
+++ b/README.rst
@@ -129,6 +129,8 @@ Getting started
Adding new configuration output formats should be relatively straightforward.
See the implementation of ``write_config()`` in `kconfiglib.py
<https://github.com/ulfalizer/Kconfiglib/blob/master/kconfiglib.py>`_.
+ The documentation for the ``Symbol.config_string`` property has some tips as
+ well.
5. To update an old ``.config`` file after the Kconfig files have changed (e.g.
to add new options), run ``oldconfig`` (prompts for values for new options)
@@ -642,9 +644,12 @@ Notes
2, see `kconfiglib-2-changes.txt
<https://github.com/ulfalizer/Kconfiglib/blob/master/kconfiglib-2-changes.txt>`_.
-* I sometimes see people add custom output formats, which is pretty straightforward to do (see the implementations of
- ``write_autoconf()`` and ``write_config()`` for a template). If you come up with something you think might
- be useful to other people, I'm happy to take it in upstream. Batteries included and all that.
+* I sometimes see people add custom output formats, which is pretty
+ straightforward to do (see the implementations of ``write_autoconf()`` and
+ ``write_config()`` for a template, and also the documentation of the
+ ``Symbol.config_string`` property). If you come up with something you think
+ might be useful to other people, I'm happy to take it in upstream. Batteries
+ included and all that.
* Kconfiglib assumes the modules symbol is ``MODULES``, which is backwards-compatible.
A warning is printed by default if ``option modules`` is set on some other symbol.