diff mbox series

[bug#60582,v3,2/2] services: lightdm: Sync documentation with source.

Message ID 6a46a643dbd361fd188a67f3d5f59feeead08cfe.1673645697.git.mirai@makinata.eu
State New
Headers show
Series [bug#60582,v3,1/2] services: configuration: Format a list of packages by their names. | expand

Commit Message

Bruno Victal Jan. 13, 2023, 9:34 p.m. UTC
Table entry @item nodes cannot span multiple lines.

* gnu/services/lightdm.scm
(lightdm-gtk-greeter-configuration): Fix cursor-theme-size description.
* doc/guix.texi (lightdm-service-type): Sync with source.
---
 doc/guix.texi            | 12 ++++--------
 gnu/services/lightdm.scm |  2 +-
 2 files changed, 5 insertions(+), 9 deletions(-)

Comments

Maxim Cournoyer Feb. 9, 2023, 3:39 a.m. UTC | #1
Hello,

Bruno Victal <mirai@makinata.eu> writes:

> Table entry @item nodes cannot span multiple lines.

So it needed some manual fix-up?  Good to know; working toward
automating the expansion of the auto-generated parts in the manual,
we'll have to figure that.  Future work!

LGTM.
Maxim Cournoyer Feb. 9, 2023, 4 a.m. UTC | #2
Hello!

I merged this series as 8a2c2eaa90.

Thank you!
Bruno Victal Feb. 9, 2023, 4:17 p.m. UTC | #3
On 2023-02-09 03:39, Maxim Cournoyer wrote:
> Bruno Victal <mirai@makinata.eu> writes:
> 
>> Table entry @item nodes cannot span multiple lines.
> 
> So it needed some manual fix-up?  Good to know; working toward
> automating the expansion of the auto-generated parts in the manual,
> we'll have to figure that.  Future work!

The automatic expansion works correctly, this was an error from manually fixing up the previous entries when
`generate-documentation' couldn't handle lists of package objects.


Cheers,
Bruno
Maxim Cournoyer Feb. 9, 2023, 4:42 p.m. UTC | #4
hi,

Bruno Victal <mirai@makinata.eu> writes:

> On 2023-02-09 03:39, Maxim Cournoyer wrote:
>> Bruno Victal <mirai@makinata.eu> writes:
>> 
>>> Table entry @item nodes cannot span multiple lines.
>> 
>> So it needed some manual fix-up?  Good to know; working toward
>> automating the expansion of the auto-generated parts in the manual,
>> we'll have to figure that.  Future work!
>
> The automatic expansion works correctly, this was an error from
> manually fixing up the previous entries when
> `generate-documentation' couldn't handle lists of package objects.

I see, thanks for the explanation!
diff mbox series

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index 751d0957d8..9c369bd881 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -21818,7 +21818,7 @@  X Window
 @end lisp
 
 Or to set a PasswordFile for the classic (unsecure) VncAuth
-mecanism:
+mechanism:
 
 @lisp
 (vnc-server-command (file-append tigervnc-server "/bin/Xvnc"
@@ -21854,9 +21854,7 @@  X Window
 @item @code{lightdm-gtk-greeter} (default: @code{lightdm-gtk-greeter}) (type: file-like)
 The lightdm-gtk-greeter package to use.
 
-@item @code{assets} @
-(default: @code{(adwaita-icon-theme gnome-themes-extrahicolor-icon-theme)}) @
-(type: list-of-file-likes)
+@item @code{assets} (default: @code{(adwaita-icon-theme gnome-themes-extra hicolor-icon-theme)}) (type: list-of-file-likes)
 The list of packages complementing the greeter, such as package
 providing icon themes.
 
@@ -21882,8 +21880,7 @@  X Window
 Enable accessibility support through the Assistive Technology Service
 Provider Interface (AT-SPI).
 
-@item @code{a11y-states} @
-(default: @code{(contrast font keyboard reader)}) (type: list-of-a11y-states)
+@item @code{a11y-states} (default: @code{(contrast font keyboard reader)}) (type: list-of-a11y-states)
 The accessibility features to enable, given as list of symbols.
 
 @item @code{reader} (type: maybe-file-like)
@@ -21917,8 +21914,7 @@  X Window
 @item @code{autologin-user} (type: maybe-string)
 The username to automatically log in with by default.
 
-@item @code{greeter-session} @
-(default: @code{lightdm-gtk-greeter}) (type: greeter-session)
+@item @code{greeter-session} (default: @code{lightdm-gtk-greeter}) (type: greeter-session)
 The greeter session to use, specified as a symbol.  Currently, only
 @code{lightdm-gtk-greeter} is supported.
 
diff --git a/gnu/services/lightdm.scm b/gnu/services/lightdm.scm
index 7e3864fec2..0b9094cda1 100644
--- a/gnu/services/lightdm.scm
+++ b/gnu/services/lightdm.scm
@@ -151,7 +151,7 @@  (define-configuration lightdm-gtk-greeter-configuration
    "The name of the cursor theme to use.")
   (cursor-theme-size
    (number 16)
-   "The size to use for the the cursor theme.")
+   "The size to use for the cursor theme.")
   (allow-debugging?
    maybe-boolean
    "Set to #t to enable debug log level.")