From 3cf9eec70095c0afded41767d76047a912e4e1b8 Mon Sep 17 00:00:00 2001 From: Sean Patrick Santos Date: Thu, 25 Aug 2016 14:43:55 -0600 Subject: [PATCH] Use `configure` description as docstring. --- tools/configure | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/tools/configure b/tools/configure index 6ebe7eea4685..dd3fab6560cd 100755 --- a/tools/configure +++ b/tools/configure @@ -1,5 +1,20 @@ #!/usr/bin/env python +"""This script writes CIME build information to a directory. + +The pieces of information that will be written include: + +1. Machine-specific build settings (i.e. the "Macros" file). +2. File-specific build settings (i.e. "Depends" files). +3. Environment variable loads (i.e. the env_mach_specific files). + +The .env_mach_specific.sh and .env_mach_specific.csh files are specific to a +given compiler, MPI library, and DEBUG setting. By default, these will be the +machine's default compiler, the machine's default MPI library, and FALSE, +respectively. These can be changed by setting the environment variables +COMPILER, MPILIB, and DEBUG, respectively. +""" + import os import shutil import sys @@ -21,20 +36,7 @@ logger = logging.getLogger(__name__) def parse_command_line(args): """Command line argument parser for configure.""" - description = """This script writes CIME build information to a directory. - -The pieces of information that will be written include: - -1. Machine-specific build settings (i.e. the "Macros" file). -2. File-specific build settings (i.e. "Depends" files). -3. Environment variable loads (i.e. the env_mach_specific files). - -The .env_mach_specific.sh and .env_mach_specific.csh files are specific to a -given compiler, MPI library, and DEBUG setting. By default, these will be the -machine's default compiler, the machine's default MPI library, and FALSE, -respectively. These can be changed by setting the environment variables -COMPILER, MPILIB, and DEBUG, respectively. -""" + description = __doc__ parser = argparse.ArgumentParser(description=description) CIME.utils.setup_standard_logging_options(parser)