From c70a45eb935dc536ce59ec860c17b4c1c531a663 Mon Sep 17 00:00:00 2001
From: Ulf Magnusson <ulfalizer@gmail.com>
Date: Fri, 22 Mar 2019 15:42:45 +0100
Subject: 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.
---
 alldefconfig.py | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

(limited to 'alldefconfig.py')

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
 
-- 
cgit v1.2.3