Skip to content

Commit

Permalink
Use configure description as docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
quantheory committed Aug 25, 2016
1 parent 23dd5af commit 3cf9eec
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions tools/configure
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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)

Expand Down

0 comments on commit 3cf9eec

Please sign in to comment.