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 /oldconfig.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 'oldconfig.py')
| -rwxr-xr-x | oldconfig.py | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/oldconfig.py b/oldconfig.py index 1593290..6f9950e 100755 --- a/oldconfig.py +++ b/oldconfig.py @@ -3,23 +3,25 @@ # Copyright (c) 2018-2019, Ulf Magnusson # SPDX-License-Identifier: ISC -# Implements oldconfig functionality: -# -# 1. Load existing .config -# 2. Prompt the user for the value of all modifiable symbols/choices that -# aren't already set in the .config -# 3. Write new .config -# -# The default input/output filename is '.config'. A different filename can be -# passed in the KCONFIG_CONFIG environment variable. -# -# Unlike 'make oldconfig', this script doesn't print menu titles and comments, -# but gives Kconfig definition locations. Printing menus and comments would be -# pretty easy to add: Look at the parents of each item and print all menu -# prompts and comments unless they have already been printed (assuming you want -# to skip "irrelevant" menus). -# -# Entering '?' displays the help text of the symbol/choice, if any. +""" +Implements oldconfig functionality. + + 1. Loads existing .config + 2. Prompts for the value of all modifiable symbols/choices that + aren't already set in the .config + 3. Writes an updated .config + +The default input/output filename is '.config'. A different filename can be +passed in the KCONFIG_CONFIG environment variable. + +Entering '?' displays the help text of the symbol/choice, if any. + +Unlike 'make oldconfig', this script doesn't print menu titles and comments, +but gives Kconfig definition locations. Printing menus and comments would be +pretty easy to add: Look at the parents of each item, and print all menu +prompts and comments unless they have already been printed (assuming you want +to skip "irrelevant" menus). +""" from __future__ import print_function |