diff options
Diffstat (limited to 'lib/spack/spack/build_environment.py')
| -rw-r--r-- | lib/spack/spack/build_environment.py | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/lib/spack/spack/build_environment.py b/lib/spack/spack/build_environment.py index c9be0bc1d8..7e99dc6441 100644 --- a/lib/spack/spack/build_environment.py +++ b/lib/spack/spack/build_environment.py @@ -455,11 +455,11 @@ def determine_number_of_jobs( cap to the number of CPUs available to avoid oversubscription. Parameters: - parallel (bool): true when package supports parallel builds - command_line (int/None): command line override - config_default (int/None): config default number of jobs - max_cpus (int/None): maximum number of CPUs available. When None, this - value is automatically determined. + parallel (bool or None): true when package supports parallel builds + command_line (int or None): command line override + config_default (int or None): config default number of jobs + max_cpus (int or None): maximum number of CPUs available. When None, this + value is automatically determined. """ if not parallel: return 1 @@ -685,14 +685,14 @@ def get_std_cmake_args(pkg): """List of standard arguments used if a package is a CMakePackage. Returns: - list of str: standard arguments that would be used if this + list: standard arguments that would be used if this package were a CMakePackage instance. Args: - pkg (PackageBase): package under consideration + pkg (spack.package.PackageBase): package under consideration Returns: - list of str: arguments for cmake + list: arguments for cmake """ return spack.build_systems.cmake.CMakePackage._std_args(pkg) @@ -701,14 +701,14 @@ def get_std_meson_args(pkg): """List of standard arguments used if a package is a MesonPackage. Returns: - list of str: standard arguments that would be used if this + list: standard arguments that would be used if this package were a MesonPackage instance. Args: - pkg (PackageBase): package under consideration + pkg (spack.package.PackageBase): package under consideration Returns: - list of str: arguments for meson + list: arguments for meson """ return spack.build_systems.meson.MesonPackage._std_args(pkg) @@ -738,7 +738,7 @@ def load_external_modules(pkg): associated with them. Args: - pkg (PackageBase): package to load deps for + pkg (spack.package.PackageBase): package to load deps for """ for dep in list(pkg.spec.traverse()): external_modules = dep.external_modules or [] @@ -864,7 +864,7 @@ def modifications_from_dependencies(spec, context, custom_mods_only=True): CMAKE_PREFIX_PATH, or PKG_CONFIG_PATH). Args: - spec (Spec): spec for which we want the modifications + spec (spack.spec.Spec): spec for which we want the modifications context (str): either 'build' for build-time modifications or 'run' for run-time modifications """ @@ -1062,9 +1062,9 @@ def start_build_process(pkg, function, kwargs): Args: - pkg (PackageBase): package whose environment we should set up the + pkg (spack.package.PackageBase): package whose environment we should set up the child process for. - function (callable): argless function to run in the child + function (typing.Callable): argless function to run in the child process. Usage:: @@ -1149,7 +1149,7 @@ def get_package_context(traceback, context=3): """Return some context for an error message when the build fails. Args: - traceback (traceback): A traceback from some exception raised during + traceback: A traceback from some exception raised during install context (int): Lines of context to show before and after the line |