From: ludo@gnu.org (Ludovic Courtès)
To: Mathieu Lirzin <mthl@openmailbox.org>
Cc: guix-devel@gnu.org, Alex Kost <alezost@gmail.com>
Subject: Re: Texinfo in descriptions?
Date: Sun, 30 Aug 2015 19:23:12 +0200 [thread overview]
Message-ID: <87613wlmgv.fsf@gnu.org> (raw)
In-Reply-To: <87a8tbf5lu.fsf@openmailbox.org> (Mathieu Lirzin's message of "Fri, 28 Aug 2015 23:47:09 +0200")
Mathieu Lirzin <mthl@openmailbox.org> skribis:
> From e98c0ec3b609c077bf471cf838f12f54a89a0226 Mon Sep 17 00:00:00 2001
> From: Mathieu Lirzin <mthl@openmailbox.org>
> Date: Fri, 7 Aug 2015 00:10:43 +0200
> Subject: [PATCH] packages: Add package-description-string.
>
> * guix/packages.scm (package-description-string): New variable.
> * guix/utils.scm (texi->plain-text): Likewise.
> * guix/ui.scm (package->recutils): Use it.
> * gnu/packages/perl.scm (perl-devel-globaldestruction)
> (perl-devel-lexalias, perl-exporter-lite): Adapt to Texinfo's markup.
> * gnu/packages/python.scm (python2-empy): Likewise.
LGTM.
We must also make sure that the Emacs UI (and guix-web, but that’s a
different repo) use ‘package-description-string’ instead of
‘package-description’.
For Emacs, I think it’s enough to
s/package-description/package-description-string/ in guix-main.scm.
Alex?
> 5 files changed, 20 insertions(+), 5 deletions(-)
I like that it’s all it takes. :-)
Any performance figures? For instance, time of ‘guix package -s’ before
and after?
> That was my first solution before realizing that this will lead to a
> problem that this unrealistic example illustrates.
>
> ;; with fr_FR.UTF-8 locale
>
> (package-description foo)
> => "socks @code{foo}."
>
> (package-description-string foo)
> => "socks `foo'.\n\n"
>
> (N_ (package-description foo))
> => "chaussettes @code{foo}."
>
> (N_ (package-description-string foo))
> => "socks `foo'.\n\n"
>
> In the last evaluation gettext was unable to find the translated string
> corresponding to msgid "socks `foo'.\n\n".
What about moving ‘package-description-string’ to (guix ui) and have it
do both rendering and translation?
If an application really needs rendered-but-not-translated stuff, it can
always use (compose texi-fragment->text package-description); I think
that’d be an unusual use case anyway.
>> Also I think the same replacement should be done in (guix scripts
>> lint) ...
>
> I think more can be done in (guix scripts lint). For example checking
> if invoking 'package-description-string' fails which would indicate that
> the markup is not correctly used.
Sure, we should do that after.
>> ... and (guix scripts package).
>
> This script uses 'package-description' to search in it. IIUC it was
> suggested by Ludo to search using the raw Texinfo fragment and to
> display using the plain-text version.
> <https://lists.gnu.org/archive/html/guix-devel/2015-07/msg00609.html>
Right, since ‘package->recutils’ uses ‘package-description-string’, we
know that all the output is correctly rendered and translated.
Nice work, thanks!
Ludo’.
next prev parent reply other threads:[~2015-08-30 17:23 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
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 [this message]
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=87613wlmgv.fsf@gnu.org \
--to=ludo@gnu.org \
--cc=alezost@gmail.com \
--cc=guix-devel@gnu.org \
--cc=mthl@openmailbox.org \
/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).