[PATCH] doc: Use @code rather than @var for data type items.

  • Done
  • quality assurance status badge
Details
2 participants
  • Ludovic Courtès
  • Christopher Baines
Owner
unassigned
Submitted by
Christopher Baines
Severity
normal
C
C
Christopher Baines wrote on 27 Oct 2020 10:54
(address . guix-patches@gnu.org)
20201027095415.18584-1-mail@cbaines.net
In the couple of cases where it's inconsistent.

* doc/guix.texi (PostgreSQL, Sound Services): Replace @var with @code within
data type sections.
---
doc/guix.texi | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)

Toggle diff (62 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index a8aa2de0a6..ed15876ed5 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -18564,20 +18564,20 @@ without a @code{pulseaudio} package, consider enabling it through the
Data type representing the configuration for @code{pulseaudio-service}.
@table @asis
-@item @var{client-conf} (default: @code{'()})
+@item @code{client-conf} (default: @code{'()})
List of settings to set in @file{client.conf}.
Accepts a list of strings or a symbol-value pairs. A string will be
inserted as-is with a newline added. A pair will be formatted as
``key = value'', again with a newline added.
-@item @var{daemon-conf} (default: @code{'((flat-volumes . no))})
+@item @code{daemon-conf} (default: @code{'((flat-volumes . no))})
List of settings to set in @file{daemon.conf}, formatted just like
@var{client-conf}.
-@item @var{script-file} (default: @code{(file-append pulseaudio "/etc/pulse/default.pa")})
+@item @code{script-file} (default: @code{(file-append pulseaudio "/etc/pulse/default.pa")})
Script file to use as @file{default.pa}.
-@item @var{system-script-file} (default: @code{(file-append pulseaudio "/etc/pulse/system.pa")})
+@item @code{system-script-file} (default: @code{(file-append pulseaudio "/etc/pulse/system.pa")})
Script file to use as @file{system.pa}.
@end table
@end deftp
@@ -18640,24 +18640,24 @@ Data type representing the configuration for the
@code{postgresql-service-type}.
@table @asis
-@item @var{postgresql}
+@item @code{postgresql}
PostgreSQL package to use for the service.
-@item @var{port} (default: @code{5432})
+@item @code{port} (default: @code{5432})
Port on which PostgreSQL should listen.
-@item @var{locale} (default: @code{"en_US.utf8"})
+@item @code{locale} (default: @code{"en_US.utf8"})
Locale to use as the default when creating the database cluster.
-@item @var{config-file} (default: @code{(postgresql-config-file)})
+@item @code{config-file} (default: @code{(postgresql-config-file)})
The configuration file to use when running PostgreSQL. The default
behaviour uses the postgresql-config-file record with the default values
for the fields.
-@item @var{data-directory} (default: @code{"/var/lib/postgresql/data"})
+@item @code{data-directory} (default: @code{"/var/lib/postgresql/data"})
Directory in which to store the data.
-@item @var{extension-packages} (default: @code{'()})
+@item @code{extension-packages} (default: @code{'()})
@cindex postgresql extension-packages
Additional extensions are loaded from packages listed in
@var{extension-packages}. Extensions are available at runtime. For instance,
--
2.28.0
L
L
Ludovic Courtès wrote on 27 Oct 2020 17:41
(name . Christopher Baines)(address . mail@cbaines.net)(address . 44252@debbugs.gnu.org)
87tuuf62pe.fsf@gnu.org
Hi,

Christopher Baines <mail@cbaines.net> skribis:

Toggle quote (5 lines)
> In the couple of cases where it's inconsistent.
>
> * doc/guix.texi (PostgreSQL, Sound Services): Replace @var with @code within
> data type sections.

Good catch, LGTM!

Ludo’.
C
C
Christopher Baines wrote on 28 Oct 2020 14:06
(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 44252-done@debbugs.gnu.org)
874kmezeig.fsf@cbaines.net
Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (11 lines)
> Hi,
>
> Christopher Baines <mail@cbaines.net> skribis:
>
>> In the couple of cases where it's inconsistent.
>>
>> * doc/guix.texi (PostgreSQL, Sound Services): Replace @var with @code within
>> data type sections.
>
> Good catch, LGTM!

Great, I've pushed this along with another PostgreSQL documentation
improvement as 0105b8624dbba539677ebbfd0dc0bd35143c6fad.
-----BEGIN PGP SIGNATURE-----

iQKlBAEBCgCPFiEEPonu50WOcg2XVOCyXiijOwuE9XcFAl+ZbMdfFIAAAAAALgAo
aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldDNF
ODlFRUU3NDU4RTcyMEQ5NzU0RTBCMjVFMjhBMzNCMEI4NEY1NzcRHG1haWxAY2Jh
aW5lcy5uZXQACgkQXiijOwuE9XfHNRAAgQPCeMLFU568yB8cGx49TXlS4pmUeqzm
oMgGBlMbqQUQG2OF3v9pHb+OT7BZ7ILYlwFj2XsHtDIh4OrpQvOEPSchNHk6wtUv
x4/DCNv451tq1Xrh7r7HX3TLGi7OzSPiNQtzSCIsCV2z48dx2Inq1YTIDhHGcid3
0CZNe1KXXpuCiudEWnWAFn3lGWQjhGJbGlvSREKlEU01yqxWmgcPRgS8OZD9fGug
00OyM3kfFfDCXHw4rhehCEHzX7smt4kI+U/puGA+5cri3+nsVkZ53FExN1ryadIp
ODFj3WzNx2ffHHXesFALCbeoE8CvVFSA5UqDwPnbjcnZ20awnfTRHfvqYMaD3ZSJ
yrpo99OZvPlm8hd95vNgQaInICV0zOs/RbaisUTqRlXyB04nbNHgtjfCifQNUKvN
bkGIDDGCO3yZBjSJYfVtwMSEzd0aCEjakb9tAf7GfXuQCLw/IAoSInlIwyJkxhjJ
EmSn7cAmgq31DRwevWTcPPqBRSEUGjglNdD2cdBo/jGXT02LGnFnPQtoPNARn1J/
Cue07hRv3VXPBqs/wqhvxRpmvJO7YCUtDTmXwdKeN+h2aME0yBhJuf3oSWP4o2QX
vRhHfGO43GRL/2xpe1btodcclhVJn8goU1egE4gkLgUJnAop6Puv27yCFuHiJ/9u
41sBcv/8po4=
=XTT4
-----END PGP SIGNATURE-----

Closed
?