summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorTodd Gamblin <tgamblin@llnl.gov>2018-02-10 21:59:55 -0500
committerTodd Gamblin <tgamblin@llnl.gov>2018-02-12 20:25:17 -0800
commit8f52de32b6ce81d2c6a351bf16792b86429e10c5 (patch)
treef569932c79b8f6ed84f0c7338fa4f05f74f6fce9 /lib
parent2b7dfcd19faf08901b59eadc933bc3963088c8cc (diff)
downloadspack-8f52de32b6ce81d2c6a351bf16792b86429e10c5.tar.gz
spack-8f52de32b6ce81d2c6a351bf16792b86429e10c5.tar.bz2
spack-8f52de32b6ce81d2c6a351bf16792b86429e10c5.tar.xz
spack-8f52de32b6ce81d2c6a351bf16792b86429e10c5.zip
Add help for buildcache, reorganize command help categories
- Add proper help for `spack buildcache` subcommands - Reorganize the help categories of Spack commands so that buildcache is in packaging and diy and setup are now in build.
Diffstat (limited to 'lib')
-rw-r--r--lib/spack/spack/cmd/buildcache.py16
-rw-r--r--lib/spack/spack/cmd/diy.py2
-rw-r--r--lib/spack/spack/cmd/gpg.py2
-rw-r--r--lib/spack/spack/cmd/setup.py2
-rw-r--r--lib/spack/spack/main.py3
5 files changed, 15 insertions, 10 deletions
diff --git a/lib/spack/spack/cmd/buildcache.py b/lib/spack/spack/cmd/buildcache.py
index 653c59074a..7dc48cd220 100644
--- a/lib/spack/spack/cmd/buildcache.py
+++ b/lib/spack/spack/cmd/buildcache.py
@@ -34,8 +34,8 @@ from spack.binary_distribution import NoOverwriteException, NoGpgException
from spack.binary_distribution import NoKeyException, PickKeyException
from spack.binary_distribution import NoVerifyException, NoChecksumException
-description = "Create, download and install build cache files."
-section = "caching"
+description = "create, download and install binary packages"
+section = "packaging"
level = "long"
@@ -43,7 +43,7 @@ def setup_parser(subparser):
setup_parser.parser = subparser
subparsers = subparser.add_subparsers(help='buildcache sub-commands')
- create = subparsers.add_parser('create')
+ create = subparsers.add_parser('create', help=createtarball.__doc__)
create.add_argument('-r', '--rel', action='store_true',
help="make all rpaths relative" +
" before creating tarballs.")
@@ -63,7 +63,7 @@ def setup_parser(subparser):
help="specs of packages to create buildcache for")
create.set_defaults(func=createtarball)
- install = subparsers.add_parser('install')
+ install = subparsers.add_parser('install', help=installtarball.__doc__)
install.add_argument('-f', '--force', action='store_true',
help="overwrite install directory if it exists.")
install.add_argument('-y', '--yes-to-all', action='store_true',
@@ -74,7 +74,7 @@ def setup_parser(subparser):
help="specs of packages to install biuldache for")
install.set_defaults(func=installtarball)
- listcache = subparsers.add_parser('list')
+ listcache = subparsers.add_parser('list', help=listspecs.__doc__)
listcache.add_argument('-f', '--force', action='store_true',
help="force new download of specs")
listcache.add_argument(
@@ -82,7 +82,7 @@ def setup_parser(subparser):
help="specs of packages to search for")
listcache.set_defaults(func=listspecs)
- dlkeys = subparsers.add_parser('keys')
+ dlkeys = subparsers.add_parser('keys', help=getkeys.__doc__)
dlkeys.add_argument(
'-i', '--install', action='store_true',
help="install Keys pulled from mirror")
@@ -179,6 +179,7 @@ def match_downloaded_specs(pkgs, allow_multiple_matches=False, force=False):
def createtarball(args):
+ """create a binary package from an existing install"""
if not args.packages:
tty.die("build cache file creation requires at least one" +
" installed package argument")
@@ -240,6 +241,7 @@ def createtarball(args):
def installtarball(args):
+ """install from a binary package"""
if not args.packages:
tty.die("build cache file installation requires" +
" at least one package spec argument")
@@ -296,6 +298,7 @@ def install_tarball(spec, args):
def listspecs(args):
+ """list binary packages available from mirrors"""
specs = bindist.get_specs(args.force)
if args.packages:
pkgs = set(args.packages)
@@ -318,6 +321,7 @@ def listspecs(args):
def getkeys(args):
+ """get public keys available on mirrors"""
install = False
if args.install:
install = True
diff --git a/lib/spack/spack/cmd/diy.py b/lib/spack/spack/cmd/diy.py
index ba5c7eb954..deef0f1372 100644
--- a/lib/spack/spack/cmd/diy.py
+++ b/lib/spack/spack/cmd/diy.py
@@ -34,7 +34,7 @@ import spack.cmd.common.arguments as arguments
from spack.stage import DIYStage
description = "do-it-yourself: build from an existing source directory"
-section = "developer"
+section = "build"
level = "long"
diff --git a/lib/spack/spack/cmd/gpg.py b/lib/spack/spack/cmd/gpg.py
index b16df52e8f..b5ec97ac6a 100644
--- a/lib/spack/spack/cmd/gpg.py
+++ b/lib/spack/spack/cmd/gpg.py
@@ -28,7 +28,7 @@ import spack
import os
description = "handle GPG actions for spack"
-section = "developer"
+section = "packaging"
level = "long"
diff --git a/lib/spack/spack/cmd/setup.py b/lib/spack/spack/cmd/setup.py
index 01b40dda80..26be575553 100644
--- a/lib/spack/spack/cmd/setup.py
+++ b/lib/spack/spack/cmd/setup.py
@@ -39,7 +39,7 @@ from spack import which
from spack.stage import DIYStage
description = "create a configuration script and module, but don't build"
-section = "developer"
+section = "build"
level = "long"
diff --git a/lib/spack/spack/main.py b/lib/spack/spack/main.py
index 6421c5a4cc..f2e5d8fafb 100644
--- a/lib/spack/spack/main.py
+++ b/lib/spack/spack/main.py
@@ -80,7 +80,8 @@ section_descriptions = {
section_order = {
'basic': ['list', 'info', 'find'],
'build': ['fetch', 'stage', 'patch', 'configure', 'build', 'restage',
- 'install', 'uninstall', 'clean']
+ 'install', 'uninstall', 'clean'],
+ 'packaging': ['create', 'edit']
}
# Properties that commands are required to set.