[bug#77172] doc: Fix default values for gitolite-configuration.

Message ID fc65c9535700408cbfc07dbd48e9f559ee55d281.1742641449.git.~@wolfsden.cz
State New
Headers
Series [bug#77172] doc: Fix default values for gitolite-configuration. |

Commit Message

Tomas Volf March 22, 2025, 11:04 a.m. UTC
  * doc/guix.texi (Version Control Services)<gitolite-configuration>[package]
[admin-pubkey, rc-file, home-directory]: Use @code.
[user, group]: Use @code.  Wrap the value in ".

Change-Id: I1a96826e339d4372d54bb29d22f3fa84f255cb0f
---
 doc/guix.texi | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
  

Comments

Maxim Cournoyer March 23, 2025, 1:45 a.m. UTC | #1
Tomas Volf <~@wolfsden.cz> writes:

> * doc/guix.texi (Version Control Services)<gitolite-configuration>[package]

nitpick: I think it's nowadays more conventional to put a space between
each changelog "specifiers", e.g.:

* doc/guix.texi (Version Control Services) <gitolite-configuration>
[package, admin-pubkey, ...]:

Otherwise, LGTM.  Applied.
  

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index a59525f52e..b6b1ab11c5 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -41112,7 +41112,7 @@  Version Control Services
 Data type representing the configuration for @code{gitolite-service-type}.
 
 @table @asis
-@item @code{package} (default: @var{gitolite})
+@item @code{package} (default: @code{gitolite})
 Gitolite package to use.  There are optional Gitolite dependencies that
 are not included in the default package, such as Redis and git-annex.
 These features can be made available by using the @code{make-gitolite}
@@ -41129,21 +41129,21 @@  Version Control Services
 (make-gitolite (list redis git-annex))
 @end example
 
-@item @code{user} (default: @var{git})
+@item @code{user} (default: @code{"git"})
 User to use for Gitolite.  This will be user that you use when accessing
 Gitolite over SSH.
 
-@item @code{group} (default: @var{git})
+@item @code{group} (default: @code{"git"})
 Group to use for Gitolite.
 
-@item @code{home-directory} (default: @var{"/var/lib/gitolite"})
+@item @code{home-directory} (default: @code{"/var/lib/gitolite"})
 Directory in which to store the Gitolite configuration and repositories.
 
-@item @code{rc-file} (default: @var{(gitolite-rc-file)})
+@item @code{rc-file} (default: @code{(gitolite-rc-file)})
 A ``file-like'' object (@pxref{G-Expressions, file-like objects}),
 representing the configuration for Gitolite.
 
-@item @code{admin-pubkey} (default: @var{#f})
+@item @code{admin-pubkey} (default: @code{#f})
 A ``file-like'' object (@pxref{G-Expressions, file-like objects}) used to
 setup Gitolite.  This will be inserted in to the @file{keydir} directory
 within the gitolite-admin repository.