Merge branch 't/30865/sage_bootstrap__update_extend_system_package_tools' into t/30947/src_doc_bootstrap__simplify_by_using_new_options_of__sage__package_list_

Author: Matthias Koeppe

build/sage_bootstrap/cmdline.py

@@ -32,7 +32,12 @@
 
 description = \
 """
-Sage Bootstrap Library
+SageMath Bootstrap Library
+
+Provides scripts to manage the packages of Sage-the-distribution,
+including SageMath's database of equivalent system packages,
+and to download and upload tarballs from/to SageMath servers.
+
 """
 
 
@@ -58,7 +63,7 @@
 
 epilog_list = \
 """
-Print a list of all available packages
+Print a list of packages known to Sage
 
 EXAMPLE:
 
@@ -197,15 +202,17 @@ def make_parser():
     parser_list = subparsers.add_parser(
         'list', epilog=epilog_list,
         formatter_class=argparse.RawDescriptionHelpFormatter,
-        help='Print a list of all available packages')
+        help='Print a list of packages known to Sage')
     parser_list.add_argument(
-        'package_class',
+        'package_class', metavar='[package_name|:package_type:]',
         type=str, default=[':all:'], nargs='*',
-        help='Package class like :all: (default) or :standard:')
+        help=('package name or designator for all packages of a given type '
+              '(one of :all:, :standard:, :optional:, :experimental:, and :huge:); '
+              'default: :all:'))
     parser_list.add_argument(
         '--has-file', action='append', default=[], metavar='FILENAME', dest='has_files',
-        help='Only include packages that have this file')
-
+        help=('only include packages that have this file in their metadata directory'
+              '(examples: SPKG.rst, spkg-configure.m4, distros/debian.txt)'))
     parser_name = subparsers.add_parser(
         'name', epilog=epilog_name,
         formatter_class=argparse.RawDescriptionHelpFormatter,

build/sage_bootstrap/expand_class.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Utility to specify classes of packages like `:all:`
+Utility to manage lists of packages
 """
 
 
@@ -44,10 +44,11 @@ def included_in_filter(pkg):
             elif package_name_or_class == ':huge:':
                 self._init_huge(predicate=included_in_filter)
             else:
-                if package_name_or_class.startswith(':'):
-                    raise ValueError('Package name cannot start with ":", got %s', package_name_or_class)
-                if package_name_or_class.endswith(':'):
-                    raise ValueError('Package name cannot end with ":", got %s', package_name_or_class)
+                if ':' in package_name_or_class:
+                    raise ValueError('a colon may only appear in designators of package types, '
+                                     'which must be one of '
+                                     ':all:, :standard:, :optional:, :experimental:, or :huge:, '
+                                     'got {}'.format(package_name_or_class))
                 self.names.append(package_name_or_class)
 
     def _init_all(self, predicate):

build/sage_bootstrap/package.py

@@ -148,7 +148,7 @@ def tarball_filename(self):
         """
         pattern = self.tarball_pattern
         if pattern:
-            return self.tarball_pattern.replace('VERSION', self.version)
+            return pattern.replace('VERSION', self.version)
         else:
             return None