GNU bug report logs - #60834
configuration->documentation generates garbage @-command on fields beginning with numeric characters

Previous Next

To reply to this bug, email your comments to 60834 AT debbugs.gnu.org.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Bruno Victal <mirai <at> makinata.eu>
To: bug-guix <bug-guix <at> gnu.org>
Subject: configuration->documentation generates garbage @-command on fields
 beginning with numeric characters
Date: Sun, 15 Jan 2023 14:34:31 +0000

Minimal example (with Guix REPL):

--8<---------------cut here---------------start------------->8---
scheme@(guix-user)> ,use (gnu services configuration)
scheme@(guix-user)> (define serialize-boolean (lambda (x y) #t))
scheme@(guix-user)> (define-configuration example-configuration (1-foo (boolean #t) "lorem ipsum"))
scheme@(guix-user)> (configuration->documentation 'example-configuration)
%example-configuration
@c %start of fragment

@deftp {Data Type} example-configuration
Available @code{example-configuration} fields are:

@table @asis
@item @code{#@{1-foo@}#} (default: @code{#t}) (type: boolean)
lorem ipsum

@end table

@end deftp


@c %end of fragment
scheme@(guix-user)> 
--8<---------------cut here---------------end--------------->8---

Message #12 received at 60834 <at> debbugs.gnu.org (full text, mbox):

From: Bruno Victal <mirai <at> makinata.eu>
To: 60834 <at> debbugs.gnu.org
Subject: Re: bug#60834: configuration->documentation generates garbage
 @-command on fields beginning with numeric characters
Date: Thu, 6 Apr 2023 14:20:22 +0100

This seems to be an issue involving how 'object->string' works:

--8<---------------cut here---------------start------------->8---
scheme@(guile-user)> (object->string '1-foo)
$1 = "#{1-foo}#"
scheme@(guile-user)> (object->string '-foo)
$2 = "-foo"
scheme@(guile-user)> (object->string 'foo-1-bar)
$3 = "foo-1-bar"
scheme@(guile-user)> (object->string 'foo-1)
$4 = "foo-1"
scheme@(guile-user)>
--8<---------------cut here---------------end--------------->8---


Grepping guile source, we see that 'format' also uses 'object->string' for the ~a format, which prints:

--8<---------------cut here---------------start------------->8---
scheme@(guile-user)> (format #t "Expected: ~a, ~a; Unexpected: ~a;~%" 'foo '-foo '1-foo)
Expected: foo, -foo; Unexpected: #{1-foo}#;
$5 = #t
scheme@(guile-user)>
--8<---------------cut here---------------end--------------->8---

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.