summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorMaxim Cournoyer <maxim.cournoyer@gmail.com>2024-01-26 14:37:17 -0500
committerMaxim Cournoyer <maxim.cournoyer@gmail.com>2024-01-26 15:04:13 -0500
commit2b0f47580948deb2884aade5131e129702eb8fc9 (patch)
tree3621ec45eda6f811a2ac123b48ccbd64a1da9a32 /doc
parent8ae8b9804fa4aef23d4028563559bf7bec52fec2 (diff)
downloadguix-2b0f47580948deb2884aade5131e129702eb8fc9.tar.gz
doc: Define postgresql-service-type as a variable.
Using defvar for service types causes them to be part of the index, which is
useful for discoverability.

* doc/guix.texi (Database Services) <postgresql-service-type>: Define with
defvar.

Change-Id: If1c920ad275a9386ec7bb9e48e9a132df98dee97
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index db0c751ded..3854c9f67d 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -25798,6 +25798,9 @@ The @code{(gnu services databases)} module provides the following services.
 
 @subsubheading PostgreSQL
 
+@defvar postgresql-service-type
+The service type for the PostgreSQL database server.  Its value should
+be a valid @code{postgresql-configuration} object, documented below.
 The following example describes a PostgreSQL service with the default
 configuration.
 
@@ -25824,6 +25827,7 @@ sudo -u postgres -s /bin/sh
 createuser --interactive
 createdb $MY_USER_LOGIN      # Replace appropriately.
 @end example
+@end defvar
 
 @deftp {Data Type} postgresql-configuration
 Data type representing the configuration for the