diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing.texi | 2 | ||||
| -rw-r--r-- | doc/guix.texi | 55 |
2 files changed, 41 insertions, 16 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi index 34def99c9b..6d3f1622f3 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -1449,7 +1449,7 @@ already ran @code{bootstrap} and @code{configure}: The first command updates all packages in @code{(gnu packages astronomy)} to the latest versions and writes changes back to the file. -The second invokes @code{etc/commiter.scm} script, a helper script for +The second invokes @code{etc/committer.scm} script, a helper script for larger scale updates; it identifies each package diff and creates corresponding commits with the correct style. diff --git a/doc/guix.texi b/doc/guix.texi index 94bda2cc9d..bffaeb5bbc 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -135,6 +135,7 @@ Copyright @copyright{} 2024-2025 Nigko Yerden@* Copyright @copyright{} 2024 Troy Figiel@* Copyright @copyright{} 2024 Sharlatan Hellseher@* Copyright @copyright{} 2024 45mg@* +Copyright @copyright{} 2024 Greg Hogan@* Copyright @copyright{} 2025 Sören Tempel@* Copyright @copyright{} 2025 Rostislav Svoboda@* Copyright @copyright{} 2025 Zacchaeus@* @@ -9704,16 +9705,40 @@ This variable is exported by @code{(guix build-system cmake)}. It implements the build procedure for packages using the @url{https://www.cmake.org, CMake build tool}. -It automatically adds the @code{cmake} package to the set of inputs. -Which package is used can be specified with the @code{#:cmake} -parameter. +This build system adds the following keyword parameters to the ones +defined by @code{gnu-build-system}: + +@table @code +@item #:cmake +The @code{cmake} package is added to the set of inputs. Which package +is used can be specified with the @code{#:cmake} parameter. + +@item #:build-type +The @code{#:build-type} parameter specifies in abstract terms the flags +passed to the compiler; it defaults to @code{"RelWithDebInfo"} (short +for ``release mode with debugging information''), which roughly means +that code is compiled with @code{-O2 -g}, as is the case for +Autoconf-based packages by default. + +@item #:generator +This parameter specifies the +@url{https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html, CMake generator} +responsible for writing the input files for the native build system. -The @code{#:configure-flags} parameter is taken as a list of flags -passed to the @command{cmake} command. The @code{#:build-type} -parameter specifies in abstract terms the flags passed to the compiler; -it defaults to @code{"RelWithDebInfo"} (short for ``release mode with -debugging information''), which roughly means that code is compiled with -@code{-O2 -g}, as is the case for Autoconf-based packages by default. +@item #:test-exclude +Tests matching this regular expression are excluded from testing by +@url{https://cmake.org/cmake/help/latest/manual/ctest.1.html, ctest}. + +@item #:test-repeat-until-pass? +Directs @url{https://cmake.org/cmake/help/latest/manual/ctest.1.html, ctest} to +@url{https://cmake.org/cmake/help/latest/manual/ctest.1.html#cmdoption-ctest-repeat, repeat} +failed tests up to @code{#:test-repeat-until-pass-count} times and is enabled by +default. + +@item #:test-repeat-until-pass-count +When @code{#:test-repeat-until-pass?} is enabled this parameter sets the maximum +number of failures for each test. The default is @code{5}. +@end table @end defvar @defvar composer-build-system @@ -23306,7 +23331,7 @@ This must be either @code{'client} or @code{'server}. Otherwise, an error is raised. Set the @code{'server} value if you want to run a bridge to help censored users connect to the Tor network, see @url{https://community.torproject.org/relay/setup/bridge/, -the Tor project's brige guide}. Set the @code{'client} value +the Tor project's bridge guide}. Set the @code{'client} value if you want to connect to somebody else's bridge, see @url{https://bridges.torproject.org/, the Tor project's ``Get Bridges'' page}. In both cases the required @@ -38929,7 +38954,7 @@ system shutdown. @quotation Note @code{battery-level}, @code{remaining-minutes}, and @code{timeout} work -in a conjunction, so the first that occurs will cause the initation of a +in a conjunction, so the first that occurs will cause the initiation of a shutdown. @end quotation @@ -38940,7 +38965,7 @@ apcupsd will initiate a system shutdown. @quotation Note @code{battery-level}, @code{remaining-minutes}, and @code{timeout} work -in a conjunction, so the first that occurs will cause the initation of a +in a conjunction, so the first that occurs will cause the initiation of a shutdown. @end quotation @@ -38951,7 +38976,7 @@ of 0 disables this timer. @quotation Note @code{battery-level}, @code{remaining-minutes}, and @code{timeout} work -in a conjunction, so the first that occurs will cause the initation of a +in a conjunction, so the first that occurs will cause the initiation of a shutdown. @end quotation @@ -42957,7 +42982,7 @@ cache. Use with caution. @end quotation @quotation Warning -@option{'share} will not work for multiple concurrent invokation of +@option{'share} will not work for multiple concurrent invocation of @command{guix}, e.g. if two user accounts run @command{guix time machine} at the same time, the results will be fun but not useful. @end quotation @@ -51274,7 +51299,7 @@ following configuration: "/home/alice/Pictures")))))))) @end lisp -In general it is preferrable to extend the @code{home-restic-backup-service-type}, +In general it is preferable to extend the @code{home-restic-backup-service-type}, as shown in the example above. This is because it takes care of wrapping everything with @code{for-home}, which enables the @code{home-restic-backup-service-type} and @code{restic-backup-service-type} to share the same codebase. |