unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
* Synchronizing descriptions with GSRC?
@ 2013-07-10 20:52 Ludovic Courtès
  2013-07-10 21:28 ` Brandon Invergo
  0 siblings, 1 reply; 15+ messages in thread
From: Ludovic Courtès @ 2013-07-10 20:52 UTC (permalink / raw)
  To: guix-devel; +Cc: Brandon Invergo

[-- Attachment #1: Type: text/plain, Size: 221 bytes --]

Hello!

After some refactoring, commit c4ca941 extends our
<gnu-package-description> structures to incorporate a ‘description’
field whose value is taken from GSRC’s manifest [0].

If you apply this patch:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Type: text/x-patch, Size: 1057 bytes --]

diff --git a/build-aux/sync-synopses.scm b/build-aux/sync-synopses.scm
index c1049d3..7d64533 100644
--- a/build-aux/sync-synopses.scm
+++ b/build-aux/sync-synopses.scm
@@ -58,5 +58,15 @@
                 (format (guix-warning-port)
                         "~a: ~a: proposed synopsis: ~s~%"
                         (location->string loc) (package-name package)
-                        upstream)))))
+                        upstream)))
+
+            (let ((upstream   (gnu-package-doc-description descriptor))
+                  (downstream (package-description package))
+                  (loc        (or (package-field-location package 'description)
+                                  (package-location package))))
+              (when (and upstream (not (string=? upstream downstream)))
+                (format (guix-warning-port)
+                        "~a: ~a: proposed description:~%    ~a~%"
+                        (location->string loc) (package-name package)
+                        (fill-paragraph upstream 79 5))))))
           gnus)


[-- Attachment #3: Type: text/plain, Size: 1081 bytes --]


then ‘make sync-synopses’ reports suggested descriptions (and if you do
it from Emacs with M-x compile, you can use C-x ` to jump to the
location in Guix, and thus easily compare the descriptions.)

After a quick glance over the differences, it’s not clear to me what
should be done.  Often, descriptions in GSRC are shorter that what we
have.  Sometimes they’re the same, or stripped version of those we have.
Sometimes they paraphrase those we have.

Descriptions in Guix are typically taken from the upstream web page or
README file, so I would intuitively feel like the upstream description
better characterizes the package.

I find some of the stripped descriptions better (Bison, for instance),
while others look too terse to me (GMP, MPFR, and MPC, for instance).

Perhaps we should have clearer criteria as for what to put in
descriptions, to start with.

Anyway, what do people think?

Would someone like to compare all these and pick-and-choose?

Thanks,
Ludo’.

[0] http://lists.gnu.org/archive/html/bug-guix/2013-04/msg00117.html

^ permalink raw reply related	[flat|nested] 15+ messages in thread
end of thread, other threads:[~2013-10-09 21:48 UTC | newest]

Thread overview: 15+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-07-10 20:52 Synchronizing descriptions with GSRC? Ludovic Courtès
2013-07-10 21:28 ` Brandon Invergo
2013-07-10 22:03   ` Ludovic Courtès
2013-07-15 21:44     ` Brandon Invergo
2013-07-15 22:45       ` Nikita Karetnikov
2013-07-16 14:06         ` Ludovic Courtès
2013-07-16 22:54           ` Nikita Karetnikov
2013-10-08 21:44     ` Brandon Invergo
2013-10-08 22:16       ` Karl Berry
2013-10-09 10:14         ` Translation of package descriptions and synopses Ludovic Courtès
2013-10-09 21:48           ` Karl Berry
2013-10-08 21:45     ` Synchronizing descriptions with GSRC? Brandon Invergo
2013-10-09 11:19       ` Ludovic Courtès
2013-10-09 13:55         ` Brandon Invergo
2013-10-09 14:21         ` Ludovic Courtès

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).