From bcd424581c19c17c05d3ea06759ca48b4b4b31ef Mon Sep 17 00:00:00 2001 From: Ulf Magnusson Date: Thu, 21 Sep 2017 15:10:39 +0200 Subject: Improve README formatting --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7c9dfa5..3a33795 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ A Python library for doing stuff with [Kconfig](https://www.kernel.org/doc/Documentation/kbuild/kconfig-language.txt)-based configuration systems. Can extract information, query and set symbol values, -and read and write .config files. Highly compatible with the -scripts/kconfig/\*conf utilities in the kernel, usually invoked via make -targets such as menuconfig and defconfig. +and read and write `.config` files. Highly compatible with the +`scripts/kconfig/*conf` utilities in the kernel, usually invoked via make +targets such as `menuconfig` and `defconfig`. Supports both Python 2 and Python 3 without modification, and should also run on non-\*nix platforms @@ -18,18 +18,18 @@ Run the following commands in the kernel root: $ git clone git://github.com/ulfalizer/Kconfiglib.git $ git am Kconfiglib/makefile.patch -(Note: The directory name Kconfiglib/ is significant.) +*(Note: The directory name `Kconfiglib/` is significant.)* In addition to creating a handy interface, the make targets created by the patch (`scriptconfig` and `iscriptconfig`) are needed to pick up environment variables set in the kernel makefiles and later referenced in the Kconfig files -(ARCH, SRCARCH, and KERNELVERSION as of Linux v4.0-rc3). +(`ARCH`, `SRCARCH`, and `KERNELVERSION` as of Linux v4.0-rc3). The documentation explains how the make targets are used. The compatibility tests in the test suite also needs them. Please tell me if the patch does not apply. It should be trivial to apply manually, as it's just a block of text that needs to be inserted near the other -*conf: targets. +`*conf:` targets. ### Installation instructions for other projects ### @@ -48,7 +48,7 @@ The (extensive) documentation is generated by running $ pydoc kconfiglib -in the Kconfiglib/ directory. For HTML output, +in the `Kconfiglib/` directory. For HTML output, use $ pydoc -w kconfiglib @@ -64,9 +64,9 @@ language has some dark corners. * [genboardscfg.py](http://git.denx.de/?p=u-boot.git;a=blob;f=tools/genboardscfg.py;hb=HEAD) from [Das U-Boot](http://www.denx.de/wiki/U-Boot) generates some sort of legacy board database by pulling information from a newly added Kconfig-based configuration system (as far as I understand it :). - * [gen-manual-lists.py](https://git.busybox.net/buildroot/tree/support/scripts/gen-manual-lists.py?id=5676a2deea896f38123b99781da0a612865adeb0) generated listings for an appendix in the Buildroot manual. (The listing has since been removed.) + * [gen-manual-lists.py](https://git.busybox.net/buildroot/tree/support/scripts/gen-manual-lists.py?id=5676a2deea896f38123b99781da0a612865adeb0) generated listings for an appendix in the [Buildroot](https://buildroot.org) manual. (The listing has since been removed.) - * [SConf](https://github.com/CoryXie/SConf) builds an interactive configuration interface (like *menuconfig*, etc.) on top of Kconfiglib, for use e.g. with SCons. + * [SConf](https://github.com/CoryXie/SConf) builds an interactive configuration interface (like `menuconfig`) on top of Kconfiglib, for use e.g. with SCons. * [kconfig-diff.py](https://gist.github.com/dubiousjim/5638961) -- a script by [dubiousjim](https://github.com/dubiousjim) that compares kernel configurations. @@ -84,7 +84,7 @@ It must be run from the top-level kernel directory. The test suite consists of a set of selftests and a set of compatibility tests that compare (character for character) configurations generated by Kconfiglib with -configurations generated by scripts/kconfig/conf for a number of cases. You +configurations generated by `scripts/kconfig/conf` for a number of cases. You might want to use the "speedy" option; see [testsuite.py](testsuite.py). The test suite might fail for a few configurations for kernels older than April 2006, @@ -133,11 +133,11 @@ to the test suite would make sense. value of each currently visible symbol every time a symbol value is changed. - * 'menuconfig' sometimes creates cosmetic menus implicitly by looking at + * `menuconfig` sometimes creates cosmetic menus implicitly by looking at dependencies. For example, a list of symbols where all symbols depend on the first symbol creates a cosmetic menu rooted at the first symbol. Recreating such menus is awkward. - + There is already basic support internally though, because it's needed to get obscure choice behavior right. See `_determine_actual_symbols()` and its helper `_has_auto_menu_dep_on()`. -- cgit v1.2.3