summaryrefslogtreecommitdiff
path: root/allnoconfig.py
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2019-03-22 15:42:45 +0100
committerUlf Magnusson <ulfalizer@gmail.com>2019-03-22 17:29:12 +0100
commitc70a45eb935dc536ce59ec860c17b4c1c531a663 (patch)
tree22afac8b77fefc6e5878b5605e1c878e0edd3345 /allnoconfig.py
parente4a71defef40b6ab640dedaf185562f343f963c9 (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 'allnoconfig.py')
-rwxr-xr-xallnoconfig.py24
1 files changed, 13 insertions, 11 deletions
diff --git a/allnoconfig.py b/allnoconfig.py
index d4aa8d0..9b66d83 100755
--- a/allnoconfig.py
+++ b/allnoconfig.py
@@ -3,17 +3,19 @@
# Copyright (c) 2018-2019, Ulf Magnusson
# SPDX-License-Identifier: ISC
-# Works like 'make allnoconfig'. Verified by the test suite to generate
-# identical output to 'make allnoconfig' for all ARCHes.
-#
-# See the examples/allnoconfig_walk.py example script for another variant.
-#
-# 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/allnoconfig.py
+"""
+Writes a configuration file where as many symbols as possible are set to 'n'.
+
+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/examples/allmodconfig.py
+
+See the examples/allnoconfig_walk.py example script for another way to
+implement this script.
+"""
import kconfiglib