From: Mathieu Lirzin <mthl@openmailbox.org>
To: Andy Wingo <wingo@igalia.com>
Cc: guix-devel@gnu.org
Subject: Re: Texinfo in descriptions?
Date: Thu, 27 Aug 2015 21:48:24 +0200 [thread overview]
Message-ID: <87egiofr7b.fsf@openmailbox.org> (raw)
In-Reply-To: <87k2si32ii.fsf@igalia.com> (Andy Wingo's message of "Wed, 26 Aug 2015 09:57:57 +0200")
Andy Wingo <wingo@igalia.com> writes:
> Will all docstrings be parsed as texinfo? To me this is the proper
> solution, since plain text is mostly a subset of texinfo.
Yes, that's the idea.
> It could be
> that all descriptions are already texinfo. You just have to be careful
> about @ { and } when used literally -- they need replacing with @@ @{
> and @}.
>
> In Guile I've had a hack that tries to render docstrings as texinfo,
> falling back to a @verbatim block otherwise, but I don't recommend it:
>
> (use-modules (texinfo) (texinfo plain-text) (ice-9 regexp))
>
> (define many-space? (make-regexp "[[:space:]][[:space:]][[:space:]]"))
> (define initial-space? (make-regexp "^[[:space:]]"))
> (define (string->stexi str)
> (or (and (or (not str) (string-null? str))
> '(*fragment*))
> (and (or (string-index str #\@)
> (and (not (regexp-exec many-space? str))
> (not (regexp-exec initial-space? str))))
> (false-if-exception
> (texi-fragment->stexi str)))
> `(*fragment* (verbatim ,str))))
> (define (string-format str)
> (stexi->plain-text (string->stexi str)))
>
> Better to just adopt texinfo and fix up any descriptions that need it.
> Probably you could use guix package -s and recutils to grep for
> descriptions that need patching.
Thank you very much for the tips and experience sharing!
--
Mathieu Lirzin
next prev parent reply other threads:[~2015-08-27 19:49 UTC|newest]
Thread overview: 49+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-07-16 11:17 [PATCH] gnu packages: Clean up synopses and descriptions Alex Kost
2015-07-16 9:40 ` Eric Bavier
2015-07-16 15:55 ` Alex Kost
2015-07-16 19:08 ` Ludovic Courtès
2015-07-17 12:41 ` Alex Kost
2015-07-17 21:24 ` Ludovic Courtès
2015-07-18 10:07 ` Alex Kost
2015-07-16 11:52 ` Mathieu Lirzin
2015-07-16 15:50 ` Ludovic Courtès
2015-07-16 21:33 ` Mathieu Lirzin
2015-07-17 21:18 ` Texinfo in descriptions? Ludovic Courtès
2015-07-21 21:37 ` Mathieu Lirzin
2015-07-22 13:35 ` Ludovic Courtès
2015-07-22 21:24 ` Ludovic Courtès
2015-07-22 22:08 ` Andreas Enge
2015-07-23 9:49 ` Mathieu Lirzin
2015-07-23 13:57 ` Ludovic Courtès
2015-07-23 15:09 ` Daniel Pimentel
2015-07-23 18:00 ` Andreas Enge
2015-08-25 22:09 ` Mathieu Lirzin
2015-08-26 7:57 ` Andy Wingo
2015-08-27 19:48 ` Mathieu Lirzin [this message]
2015-07-23 13:54 ` Ludovic Courtès
2015-08-27 21:04 ` Mathieu Lirzin
2015-08-28 21:47 ` Mathieu Lirzin
2015-08-30 17:23 ` Ludovic Courtès
2015-08-30 19:06 ` Alex Kost
2015-08-30 20:42 ` Mathieu Lirzin
2015-08-31 21:21 ` Ludovic Courtès
2015-09-01 16:41 ` Mathieu Lirzin
2015-09-02 21:27 ` Mathieu Lirzin
2015-09-03 22:12 ` Ludovic Courtès
2015-09-04 19:43 ` Mathieu Lirzin
2015-09-06 13:51 ` Ludovic Courtès
2015-09-06 20:10 ` Alex Kost
2015-09-06 21:31 ` Ludovic Courtès
2015-09-07 15:50 ` Alex Kost
2015-09-07 15:59 ` Ludovic Courtès
2015-08-30 10:10 ` Alex Kost
2015-08-30 12:24 ` Mathieu Lirzin
2015-08-30 15:19 ` Alex Kost
2015-07-17 12:35 ` [PATCHES] gnu packages: Clean up synopses and descriptions Alex Kost
2015-07-17 21:07 ` Mathieu Lirzin
2015-07-17 21:30 ` Ludovic Courtès
2015-07-18 10:08 ` Alex Kost
2015-07-18 21:13 ` Andreas Enge
2015-07-19 9:58 ` Alex Kost
2015-07-16 16:03 ` [PATCH] " Alex Kost
2015-07-16 20:02 ` Mathieu Lirzin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87egiofr7b.fsf@openmailbox.org \
--to=mthl@openmailbox.org \
--cc=guix-devel@gnu.org \
--cc=wingo@igalia.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).