[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: evaluation: Add doc strings.
From: |
Mathieu Othacehe |
Subject: |
branch master updated: evaluation: Add doc strings. |
Date: |
Fri, 05 Mar 2021 07:13:48 -0500 |
This is an automated email from the git hooks/post-receive script.
mothacehe pushed a commit to branch master
in repository guix-cuirass.
The following commit(s) were added to refs/heads/master by this push:
new 9a2f597 evaluation: Add doc strings.
9a2f597 is described below
commit 9a2f59740a97fc5c69f64a0ee13d719f3c5a4b76
Author: Mathieu Othacehe <othacehe@gnu.org>
AuthorDate: Fri Mar 5 13:13:24 2021 +0100
evaluation: Add doc strings.
* bin/evaluate.in: Add doc strings.
---
bin/evaluate.in | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/bin/evaluate.in b/bin/evaluate.in
index 0e38703..67db3e7 100644
--- a/bin/evaluate.in
+++ b/bin/evaluate.in
@@ -52,10 +52,9 @@ CHECKOUTS."
#:key
eval-id channels
spec build systems)
- "Spawn an inferior on INSTANCES that uses the given STORE. Withing that
-inferior, call PROC with PROC-ARGS arguments from MODULE. Pass PROC a
-register procedure that writes its arguments on a socket. Listen that socket
-for new jobs and register them using REGISTER-JOB procedure."
+ "Spawn an inferior on INSTANCES that uses the given STORE and PROFILE.
+Withing that inferior, call EVAL-PROC from the EVAL-MODULE. Register the
+returned jobs in database."
;; The module where the below procedure is defined.
(define eval-module '(gnu ci))
@@ -75,6 +74,8 @@ for new jobs and register them using REGISTER-JOB procedure."
(db-register-builds jobs eval-id spec))))
(define (instances->cached-profile* instances)
+ "Call INSTANCES->CACHED-PROFILE on an opened store with disable
+substitutes."
(with-store store
(set-build-options store
#:use-substitutes? #f
@@ -83,9 +84,8 @@ for new jobs and register them using REGISTER-JOB procedure."
(define* (main #:optional (args (command-line)))
"This procedure spawns an inferior on the given channels. An evaluation
-procedure is called within that inferior. The evaluation procedure is passed
-a job registration callback. The registered jobs are then read on a socket
-nd registered in database."
+procedure is called within that inferior, it returns a list of jobs that are
+registered in database."
(match args
((command database eval-str)
(parameterize ((%package-database database))
@@ -102,6 +102,10 @@ nd registered in database."
(instances->cached-profile* instances))
(channels
(map channel-instance->sexp instances)))
+ ;; Evaluate jobs on a per-system basis for two reasons. It
+ ;; speeds up the evaluation speed as the evaluations can be
+ ;; performed concurrently. It also decreases the amount of
+ ;; memory needed per evaluation process.
(par-for-each
(lambda (system)
(with-store store
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: evaluation: Add doc strings.,
Mathieu Othacehe <=