guix-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

01/08: doc: Define postgresql-service-type as a variable.


From: guix-commits
Subject: 01/08: doc: Define postgresql-service-type as a variable.
Date: Fri, 26 Jan 2024 15:39:52 -0500 (EST)

apteryx pushed a commit to branch master
in repository guix.

commit 2b0f47580948deb2884aade5131e129702eb8fc9
Author: Maxim Cournoyer <maxim.cournoyer@gmail.com>
AuthorDate: Fri Jan 26 14:37:17 2024 -0500

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

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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]