build: Fix docstring typos.
* gnu/build/image.scm (estimate-partition-size): Fix typo in docstring. * guix/build/copy-build-system.scm (install): Likewise. * guix/build/lisp-utils.scm (generate-executable): Likewise. * guix/build/maven/pom.scm (find-parent, fix-pom-dependencies): Likewise. * guix/build-system/cargo.scm (expand-crate-sources): Likewise.
This commit is contained in:
parent
6b4663363c
commit
7dff329862
5 changed files with 11 additions and 11 deletions
|
@ -60,7 +60,7 @@
|
||||||
(inexact->exact (ceiling (/ size 1024)))))
|
(inexact->exact (ceiling (/ size 1024)))))
|
||||||
|
|
||||||
(define (estimate-partition-size root)
|
(define (estimate-partition-size root)
|
||||||
"Given the ROOT directory, evalute and return its size. As this doesn't
|
"Given the ROOT directory, evaluate and return its size. As this doesn't
|
||||||
take the partition metadata size into account, take a 25% margin."
|
take the partition metadata size into account, take a 25% margin."
|
||||||
(* 1.25 (file-size root)))
|
(* 1.25 (file-size root)))
|
||||||
|
|
||||||
|
|
|
@ -217,7 +217,7 @@ any dependent crates. This can be a benefits:
|
||||||
- It avoids waiting for quadratic builds from source: cargo always builds
|
- It avoids waiting for quadratic builds from source: cargo always builds
|
||||||
dependencies within the current workspace. This is largely due to Rust not
|
dependencies within the current workspace. This is largely due to Rust not
|
||||||
having a stable ABI and other resolutions that cargo applies. This means that
|
having a stable ABI and other resolutions that cargo applies. This means that
|
||||||
if we have a depencency chain of X -> Y -> Z and we build each definition
|
if we have a dependency chain of X -> Y -> Z and we build each definition
|
||||||
independently the following will happen:
|
independently the following will happen:
|
||||||
* Cargo will build and test crate Z
|
* Cargo will build and test crate Z
|
||||||
* Cargo will build crate Z in Y's workspace, then build and test Y
|
* Cargo will build crate Z in Y's workspace, then build and test Y
|
||||||
|
|
|
@ -58,7 +58,7 @@ In the above, FILTERS are optional.
|
||||||
one of the elements in the list.
|
one of the elements in the list.
|
||||||
- With `#:include-regexp`, install subpaths matching the regexps in the list.
|
- With `#:include-regexp`, install subpaths matching the regexps in the list.
|
||||||
- The `#:exclude*` FILTERS work similarly. Without `#:include*` flags,
|
- The `#:exclude*` FILTERS work similarly. Without `#:include*` flags,
|
||||||
install every subpath but the files matching the `#:exlude*` filters.
|
install every subpath but the files matching the `#:exclude*` filters.
|
||||||
If both `#:include*` and `#:exclude*` are specified, the exclusion is done
|
If both `#:include*` and `#:exclude*` are specified, the exclusion is done
|
||||||
on the inclusion list.
|
on the inclusion list.
|
||||||
|
|
||||||
|
|
|
@ -407,7 +407,7 @@ DEPENDENCY-PREFIXES to ensure references to those libraries are retained."
|
||||||
type
|
type
|
||||||
compress?
|
compress?
|
||||||
#:allow-other-keys)
|
#:allow-other-keys)
|
||||||
"Generate an executable by using asdf operation TYPE, containing whithin the
|
"Generate an executable by using asdf operation TYPE, containing within the
|
||||||
image all DEPENDENCIES, and running ENTRY-PROGRAM in the case of an
|
image all DEPENDENCIES, and running ENTRY-PROGRAM in the case of an
|
||||||
executable. Link in any asd files from DEPENDENCY-PREFIXES to ensure
|
executable. Link in any asd files from DEPENDENCY-PREFIXES to ensure
|
||||||
references to those libraries are retained."
|
references to those libraries are retained."
|
||||||
|
|
|
@ -59,7 +59,7 @@ represents a @file{.pom} file content, or parts of it."
|
||||||
(pom-ref content "parent"))
|
(pom-ref content "parent"))
|
||||||
|
|
||||||
(define* (find-parent content inputs #:optional local-packages)
|
(define* (find-parent content inputs #:optional local-packages)
|
||||||
"Find the parent pom for the pom file whith @var{content} in a package's
|
"Find the parent pom for the pom file with @var{content} in a package's
|
||||||
@var{inputs}. When the parent pom cannot be found in @var{inputs}, but
|
@var{inputs}. When the parent pom cannot be found in @var{inputs}, but
|
||||||
@var{local-packages} is defined, the parent pom is looked up in it.
|
@var{local-packages} is defined, the parent pom is looked up in it.
|
||||||
|
|
||||||
|
@ -243,17 +243,17 @@ to re-declare the namespaces in the top-level element."
|
||||||
(define* (fix-pom-dependencies pom-file inputs
|
(define* (fix-pom-dependencies pom-file inputs
|
||||||
#:key with-plugins? with-build-dependencies?
|
#:key with-plugins? with-build-dependencies?
|
||||||
(excludes '()) (local-packages '()))
|
(excludes '()) (local-packages '()))
|
||||||
"Open @var{pom-file}, and override its content, rewritting its dependencies
|
"Open @var{pom-file}, and override its content, rewriting its dependencies
|
||||||
to set their version to the latest version available in the @var{inputs}.
|
to set their version to the latest version available in the @var{inputs}.
|
||||||
|
|
||||||
@var{#:with-plugins?} controls whether plugins are also overiden.
|
@var{#:with-plugins?} controls whether plugins are also overridden.
|
||||||
@var{#:with-build-dependencies?} controls whether build dependencies (whose
|
@var{#:with-build-dependencies?} controls whether build dependencies (whose
|
||||||
scope is not empty) are also overiden. By default build dependencies and
|
scope is not empty) are also overridden. By default build dependencies and
|
||||||
plugins are not overiden.
|
plugins are not overridden.
|
||||||
|
|
||||||
@var{#:excludes} is an association list of groupID to a list of artifactIDs.
|
@var{#:excludes} is an association list of groupID to a list of artifactIDs.
|
||||||
When a pair (groupID, artifactID) is present in the list, its entry is
|
When a pair (groupID, artifactID) is present in the list, its entry is
|
||||||
removed instead of being overiden. If the entry is ignored because of the
|
removed instead of being overridden. If the entry is ignored because of the
|
||||||
previous arguments, the entry is not removed.
|
previous arguments, the entry is not removed.
|
||||||
|
|
||||||
@var{#:local-packages} is an association list that contains additional version
|
@var{#:local-packages} is an association list that contains additional version
|
||||||
|
@ -262,7 +262,7 @@ not found in @var{inputs}, information from this list is used instead to determi
|
||||||
the latest version of the package. This is an association list of group IDs
|
the latest version of the package. This is an association list of group IDs
|
||||||
to another association list of artifact IDs to a version number.
|
to another association list of artifact IDs to a version number.
|
||||||
|
|
||||||
Returns nothing, but overides the @var{pom-file} as a side-effect."
|
Returns nothing, but overrides the @var{pom-file} as a side-effect."
|
||||||
(define pom (get-pom pom-file))
|
(define pom (get-pom pom-file))
|
||||||
|
|
||||||
(define (ls dir)
|
(define (ls dir)
|
||||||
|
|
Reference in a new issue