diff options
| author | Ulf Magnusson <ulfalizer@gmail.com> | 2019-03-22 15:42:45 +0100 |
|---|---|---|
| committer | Ulf Magnusson <ulfalizer@gmail.com> | 2019-03-22 17:29:12 +0100 |
| commit | c70a45eb935dc536ce59ec860c17b4c1c531a663 (patch) | |
| tree | 22afac8b77fefc6e5878b5605e1c878e0edd3345 /alldefconfig.py | |
| parent | e4a71defef40b6ab640dedaf185562f343f963c9 (diff) | |
Convert some comments to module docstrings in utilities
This makes running pydoc(3) on the utilities helpful.
Reuse the module docstring for the --help text for utilities that use
argparse.
Also fix some copy-paste errors in the all*config.py descriptions and
clean up the language a bit.
Piggyback removal of an optimization in allmodconfig.py that's pretty
irrelevant now.
Diffstat (limited to 'alldefconfig.py')
| -rwxr-xr-x | alldefconfig.py | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/alldefconfig.py b/alldefconfig.py index 4f0cbca..f132f1e 100755 --- a/alldefconfig.py +++ b/alldefconfig.py @@ -3,15 +3,17 @@ # Copyright (c) 2018-2019, Ulf Magnusson # SPDX-License-Identifier: ISC -# Works like 'make alldefconfig'. Verified by the test suite to generate -# identical output to 'make alldefconfig' for all ARCHes. -# -# The default output filename is '.config'. A different filename can be passed -# in the KCONFIG_CONFIG environment variable. -# -# Usage for the Linux kernel: -# -# $ make [ARCH=<arch>] scriptconfig SCRIPT=Kconfiglib/alldefconfig.py +""" +Writes a configuration file where all symbols are set to their their default +values. + +The default output filename is '.config'. A different filename can be passed in +the KCONFIG_CONFIG environment variable. + +Usage for the Linux kernel: + + $ make [ARCH=<arch>] scriptconfig SCRIPT=Kconfiglib/alldefconfig.py +""" import kconfiglib |