ryan77627/guix
1
0
Fork 0
mirror of https://git.in.rschanz.org/ryan77627/guix.git synced 2024-12-25 05:48:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

services: getmail: Fix some configuration documentation strings.

Browse source 
* gnu/services/getmail.scm (getmail-retriever-configuration): Specify proper
documentation strings for some of the fields.
* doc/guix.texi (Mail Services): Update the documentation accordingly.
This commit is contained in:
Christopher Baines 2020-01-20 19:02:32 +00:00
parent 147a7f1fd2
commit 2e1a314871
No known key found for this signature in database
GPG key ID: 5E28A33B0B84F577
2 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/guix.texi
View file

@ -17715,21 +17715,21 @@ Defaults to @samp{"SimpleIMAPSSLRetriever"}.
@end deftypevr @end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} string server @deftypevr {@code{getmail-retriever-configuration} parameter} string server
Space separated list of arguments to the userdb driver. Username to login to the mail server with.
Defaults to @samp{unset}. Defaults to @samp{unset}.
@end deftypevr @end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} string username @deftypevr {@code{getmail-retriever-configuration} parameter} string username
Space separated list of arguments to the userdb driver. Username to login to the mail server with.
Defaults to @samp{unset}. Defaults to @samp{unset}.
@end deftypevr @end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} non-negative-integer port @deftypevr {@code{getmail-retriever-configuration} parameter} non-negative-integer port
Space separated list of arguments to the userdb driver. Port number to connect to.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@ -17750,28 +17750,28 @@ Defaults to @samp{()}.
@end deftypevr @end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} string keyfile @deftypevr {@code{getmail-retriever-configuration} parameter} string keyfile
PEM-formatted key file to use for the TLS negotiation PEM-formatted key file to use for the TLS negotiation.
Defaults to @samp{""}. Defaults to @samp{""}.
@end deftypevr @end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} string certfile @deftypevr {@code{getmail-retriever-configuration} parameter} string certfile
PEM-formatted certificate file to use for the TLS negotiation PEM-formatted certificate file to use for the TLS negotiation.
Defaults to @samp{""}. Defaults to @samp{""}.
@end deftypevr @end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} string ca-certs @deftypevr {@code{getmail-retriever-configuration} parameter} string ca-certs
CA certificates to use CA certificates to use.
Defaults to @samp{""}. Defaults to @samp{""}.
@end deftypevr @end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} parameter-alist extra-parameters @deftypevr {@code{getmail-retriever-configuration} parameter} parameter-alist extra-parameters
Extra retriever parameters Extra retriever parameters.
Defaults to @samp{()}. Defaults to @samp{()}.

14
gnu/services/getmail.scm
View file

@ -112,13 +112,13 @@ (define-configuration getmail-retriever-configuration
@samp{passwd} and @samp{static}.") @samp{passwd} and @samp{static}.")
(server (server
(string 'unset) (string 'unset)
"Space separated list of arguments to the userdb driver.") "Name or IP adddress of the server to retrieve mail from.")
(username (username
(string 'unset) (string 'unset)
"Space separated list of arguments to the userdb driver.") "Username to login to the mail server with.")
(port (port
(non-negative-integer #f) (non-negative-integer #f)
"Space separated list of arguments to the userdb driver.") "Port number to connect to.")
(password (password
(string "") (string "")
"Override fields from passwd.") "Override fields from passwd.")
@ -127,16 +127,16 @@ (define-configuration getmail-retriever-configuration
"Override fields from passwd.") "Override fields from passwd.")
(keyfile (keyfile
(string "") (string "")
"PEM-formatted key file to use for the TLS negotiation") "PEM-formatted key file to use for the TLS negotiation.")
(certfile (certfile
(string "") (string "")
"PEM-formatted certificate file to use for the TLS negotiation") "PEM-formatted certificate file to use for the TLS negotiation.")
(ca-certs (ca-certs
(string "") (string "")
"CA certificates to use") "CA certificates to use.")
(extra-parameters (extra-parameters
(parameter-alist '()) (parameter-alist '())
"Extra retriever parameters")) "Extra retriever parameters."))
(define (serialize-getmail-destination-configuration field-name val) (define (serialize-getmail-destination-configuration field-name val)
(serialize-configuration val getmail-destination-configuration-fields)) (serialize-configuration val getmail-destination-configuration-fields))