futurile/guix-play
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Fixes for Texinfo metainfo.

Browse Source 
* doc/guix.texi (guix-pack)[GUIX_EXECUTION_ENGINE]: Use @env
instead of @code.
(zram-device-service-type): Use @code instead of @var for constant or
symbolic values.
(rshiny-service-type): Use @env instead of @code for R_LIBS_USER.
This commit is contained in:
Miguel Ángel Arruga Vivas 2020-10-11 19:58:22 +02:00
parent 3483e6444d
commit c2a382e510
No known key found for this signature in database
GPG Key ID: 634C6E8979FABEC2
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/guix.texi
View File

@ -5836,7 +5836,7 @@ direct syscalls are not intercepted either, leading to erratic behavior.
@vindex GUIX_EXECUTION_ENGINE @vindex GUIX_EXECUTION_ENGINE
When running a wrapped program, you can explicitly request one of the When running a wrapped program, you can explicitly request one of the
execution engines listed above by setting the execution engines listed above by setting the
@code{GUIX_EXECUTION_ENGINE} environment variable accordingly. @env{GUIX_EXECUTION_ENGINE} environment variable accordingly.
@end quotation @end quotation
@cindex entry point, for Docker images @cindex entry point, for Docker images
@ -28587,22 +28587,22 @@ This is the data type representing the configuration for the zram-device
service. service.
@table @asis @table @asis
@item @code{size} (default @var{"1G"}) @item @code{size} (default @code{"1G"})
This is the amount of space you wish to provide for the zram device. It This is the amount of space you wish to provide for the zram device. It
accepts a string and can be a number of bytes or use a suffix, eg.: accepts a string and can be a number of bytes or use a suffix, eg.:
@var{"512M"} or @var{1024000}. @code{"512M"} or @code{1024000}.
@item @code{compression-algorithm} (default @var{'lzo}) @item @code{compression-algorithm} (default @code{'lzo})
This is the compression algorithm you wish to use. It is difficult to This is the compression algorithm you wish to use. It is difficult to
list all the possible compression options, but common ones supported by list all the possible compression options, but common ones supported by
Guix's Linux Libre Kernel include @var{'lzo}, @var{'lz4} and @var{'zstd}. Guix's Linux Libre Kernel include @code{'lzo}, @code{'lz4} and @code{'zstd}.
@item @code{memory-limit} (default @var{0}) @item @code{memory-limit} (default @code{0})
This is the maximum amount of memory which the zram device can use. This is the maximum amount of memory which the zram device can use.
Setting it to '0' disables the limit. While it is generally expected Setting it to '0' disables the limit. While it is generally expected
that compression will be 2:1, it is possible that uncompressable data that compression will be 2:1, it is possible that uncompressable data
can be written to swap and this is a method to limit how much memory can can be written to swap and this is a method to limit how much memory can
be used. It accepts a string and can be a number of bytes or use a be used. It accepts a string and can be a number of bytes or use a
suffix, eg.: @var{"2G"}. suffix, eg.: @code{"2G"}.
@item @code{priority} (default @var{-1}) @item @code{priority} (default @code{-1})
This is the priority of the swap device created from the zram device. This is the priority of the swap device created from the zram device.
@code{swapon} accepts values between -1 and 32767, with higher values @code{swapon} accepts values between -1 and 32767, with higher values
indicating higher priority. Higher priority swap will generally be used indicating higher priority. Higher priority swap will generally be used
@ -29015,7 +29015,7 @@ The @code{(gnu services science)} module provides the following service.
@defvr {Scheme Variable} rshiny-service-type @defvr {Scheme Variable} rshiny-service-type
This is a type of service which is used to run a webapp created with This is a type of service which is used to run a webapp created with
@code{r-shiny}. This service sets the @code{R_LIBS_USER} environment @code{r-shiny}. This service sets the @env{R_LIBS_USER} environment
variable and runs the provided script to call @code{runApp}. variable and runs the provided script to call @code{runApp}.
@deftp {Data Type} rshiny-configuration @deftp {Data Type} rshiny-configuration