[PATCH 0/2] Fixes for the manual

  • Done
  • quality assurance status badge
Details
2 participants
  • Ludovic Courtès
  • Miguel Ángel Arruga Vivas
Owner
unassigned
Submitted by
Miguel Ángel Arruga Vivas
Severity
normal
M
M
Miguel Ángel Arruga Vivas wrote on 11 Oct 2020 21:10
(address . guix-patches@gnu.org)
87zh4s60l2.fsf@gmail.com
Hi,

These are the things I've found after the translation of the manual.

Happy hacking!
Miguel
--

Miguel Ángel Arruga Vivas (2):
doc: Fix minor typos.
doc: Fixes for Texinfo metainfo.

doc/guix.texi | 54 +++++++++++++++++++++++++--------------------------
1 file changed, 27 insertions(+), 27 deletions(-)

--
2.28.0
M
M
M
Miguel Ángel Arruga Vivas wrote on 11 Oct 2020 21:14
[PATCH 2/2] Fixes for Texinfo metainfo
(address . 43934@debbugs.gnu.org)
87pn5o60di.fsf@gmail.com
From ad0dfd58d91d319c44ea46e2f72c7196eba37ce2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Miguel=20=C3=81ngel=20Arruga=20Vivas?=
<rosen644835@gmail.com>
Date: Sun, 11 Oct 2020 19:58:22 +0200
Subject: [PATCH 2/2] doc: Fixes for Texinfo metainfo.

* 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.
---
doc/guix.texi | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)

Toggle diff (54 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index c3d9683e25..d749a6f70f 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -5824,7 +5824,7 @@ direct syscalls are not intercepted either, leading to erratic behavior.
@vindex GUIX_EXECUTION_ENGINE
When running a wrapped program, you can explicitly request one of the
execution engines listed above by setting the
-@code{GUIX_EXECUTION_ENGINE} environment variable accordingly.
+@env{GUIX_EXECUTION_ENGINE} environment variable accordingly.
@end quotation
@cindex entry point, for Docker images
@@ -28187,22 +28187,22 @@ This is the data type representing the configuration for the zram-device
service.
@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
accepts a string and can be a number of bytes or use a suffix, eg.:
-@var{"512M"} or @var{1024000}.
-@item @code{compression-algorithm} (default @var{'lzo})
+@code{"512M"} or @code{1024000}.
+@item @code{compression-algorithm} (default @code{'lzo})
This is the compression algorithm you wish to use. It is difficult to
list all the possible compression options, but common ones supported by
-Guix's Linux Libre Kernel include @var{'lzo}, @var{'lz4} and @var{'zstd}.
-@item @code{memory-limit} (default @var{0})
+Guix's Linux Libre Kernel include @code{'lzo}, @code{'lz4} and @code{'zstd}.
+@item @code{memory-limit} (default @code{0})
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
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
be used. It accepts a string and can be a number of bytes or use a
-suffix, eg.: @var{"2G"}.
-@item @code{priority} (default @var{-1})
+suffix, eg.: @code{"2G"}.
+@item @code{priority} (default @code{-1})
This is the priority of the swap device created from the zram device.
@code{swapon} accepts values between -1 and 32767, with higher values
indicating higher priority. Higher priority swap will generally be used
@@ -28615,7 +28615,7 @@ The @code{(gnu services science)} module provides the following service.
@defvr {Scheme Variable} rshiny-service-type
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}.
@deftp {Data Type} rshiny-configuration
--
2.28.0
L
L
Ludovic Courtès wrote on 17 Oct 2020 14:38
Re: [bug#43934] [PATCH 0/2] Fixes for the manual
(name . Miguel Ángel Arruga Vivas)(address . rosen644835@gmail.com)(address . 43934@debbugs.gnu.org)
877drp58o7.fsf@gnu.org
¡Hola Miguel!

Miguel Ángel Arruga Vivas <rosen644835@gmail.com> skribis:

Toggle quote (4 lines)
> Miguel Ángel Arruga Vivas (2):
> doc: Fix minor typos.
> doc: Fixes for Texinfo metainfo.

Both LGTM! You can use your new super powers to push it! (Make sure to
use the pre-push hook as described under “Commit Access”.)

In general, feel free to push fixes for typos or other obvious errors
directly, unless maybe we’re on a “string freeze”.

Thank you!

Ludo’.
M
M
Miguel Ángel Arruga Vivas wrote on 17 Oct 2020 16:24
(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 43934-done@debbugs.gnu.org)
87h7qtq6ao.fsf@gmail.com
I've just pushed them. ^.^

I'll close this report too. This is what -done are for, isn't it?

Thank you very much.
Miguel
Closed
L
L
Ludovic Courtès wrote on 19 Oct 2020 10:28
(name . Miguel Ángel Arruga Vivas)(address . rosen644835@gmail.com)(address . 43934-done@debbugs.gnu.org)
877drm39i7.fsf@gnu.org
Hola,

Miguel Ángel Arruga Vivas <rosen644835@gmail.com> skribis:

Toggle quote (4 lines)
> I've just pushed them. ^.^
>
> I'll close this report too. This is what -done are for, isn't it?

Yup, thank you! :-)

Ludo’.
Closed
?