From mboxrd@z Thu Jan 1 00:00:00 1970 From: Kyle Meyer Subject: Re: Preparing for a new release In-Reply-To: <87h801p818.fsf@elephly.net> Date: Sat, 08 Feb 2020 20:38:36 +0000 Message-ID: <87h800u84z.fsf@kyleam.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable To: Ricardo Wurmus , gwl-devel@gnu.org List-ID: Ricardo Wurmus writes: > I=E2=80=99ve pushed a bunch of the previously discussed improvements to t= he > repository and also added more documentation. Please also note the > TODO.org file, which is for ideas and plans that may not necessarily be > flully fleshed out. Thanks! > I=E2=80=99ll leave the load-path + inferior magic for a later release. T= his is > hairy stuff and I=E2=80=99d rather have us mull this over for a little wh= ile > longer before committing to an implementation. Sounds like a good idea. > Your comments on the code and the documentation, and also your > experience reports are very welcome! The added documentation looks very nice. Here are a few minor suggestions. -- >8 -- Subject: [PATCH] doc: Touch up recent changes to the manual. * doc/gwl.texi: Revise recently added text. --- doc/gwl.texi | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/gwl.texi b/doc/gwl.texi index 62eb3bc..e1ebdd2 100644 --- a/doc/gwl.texi +++ b/doc/gwl.texi @@ -93,7 +93,7 @@ Installation @chapter Installation =20 There really is no point in using the GWL without Guix. If you -already have a Guix installation you can install the GWL with +already have a Guix installation, you can install the GWL with @code{guix install gwl}. =20 The Guix Workflow Language uses the GNU build system. To install it @@ -112,7 +112,7 @@ Installation then perform the above steps. =20 Note that in order for Guix to learn about the ``workflow'' -sub-command provided by the GWL the Guile module @code{(guix scripts +sub-command provided by the GWL, the Guile module @code{(guix scripts workflow)} must be found in a directory on the @code{GUILE_LOAD_PATH}. =20 @c ********************************************************************* @@ -167,7 +167,7 @@ Defining a Process ' display "hello" @end example =20 -This creates a process with name ``hello'', which will print the +This creates a process with the name ``hello'', which will print the string @code{"hello"} once the process is executed. The @code{procedure} field holds the Scheme code that does all the work of saying ``hello''. We will talk about the @code{procedure} field a @@ -211,7 +211,7 @@ @code{process} Fields @item name The readable name of the process as a string. This is used for display purposes and to select processes by name. When the -@code{process} constructor is used the @code{name} field need not be +@code{process} constructor is used, the @code{name} field need not be provided explicitly. =20 @cindex version, process field @@ -234,7 +234,7 @@ @code{process} Fields available when executing the process. Packages can either be Guix package specifications --- such as the string @code{"guile@@3.0"} for Guile version 3.0 --- or package variable names. When using package -variable names you need to make sure to import the appropriate Guix +variable names, you need to make sure to import the appropriate Guix module at the top of your workflow file, e.g. @code{(import (gnu packages guile))} for the variable @code{guile}. =20 @@ -343,7 +343,7 @@ @code{process} Fields @item run-time This field is used to specify run-time resource estimates, such as the memory requirement of the process or the maximum time it should run. -This is especially useful when submitting jobs to a HPC cluster +This is especially useful when submitting jobs to an HPC cluster scheduler such as Grid Engine, as these schedulers may give higher priority to jobs that declare a short run time. =20 @@ -365,7 +365,7 @@ @code{process} Fields outputs "haiku.txt" synopsis "Write a haiku to a file" description - . "This process writes a haiku by Gary Hotham\ + . "This process writes a haiku by Gary Hotham \ to the file \"haiku.txt\"." procedure ` with-output-to-file ,outputs @@ -573,14 +573,14 @@ Defining a Workflow . something-else @end example =20 -This defines a workflow with name ``do-stuff'', binds it to a variable +This defines a workflow with the name ``do-stuff'', binds it to a variable @code{do-stuff}, and declares that it consists of the three processes @code{this}, @code{that}, and @code{something-else}. All of these processes will be run at the same time. This may not be what you want when the processes depend on each other. =20 @cindex auto-connect, workflow order -If the processes all declare inputs and outputs the GWL can connect +If the processes all declare inputs and outputs, the GWL can connect the processes and ensure that only independent processes are run simultaneously. Use the @code{auto-connect} procedure on your processes: base-commit: 86a19d120cf6b90bab2a24a9cd3a7793395c3222 --=20 2.25.0