From patchwork Mon Jan 6 10:19:05 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gabriel Wicki X-Patchwork-Id: 36671 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 60A6927BBEA; Mon, 6 Jan 2025 10:38:29 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-7.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,MAILING_LIST_MULTI,RCVD_IN_DNSWL_BLOCKED, RCVD_IN_VALIDITY_CERTIFIED,RCVD_IN_VALIDITY_RPBL,RCVD_IN_VALIDITY_SAFE, SPF_HELO_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id B6F3627BBE2 for ; Mon, 6 Jan 2025 10:38:28 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tUkUn-0006Jd-Sx; Mon, 06 Jan 2025 05:38:05 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tUkUl-0006J8-5f for guix-patches@gnu.org; Mon, 06 Jan 2025 05:38:03 -0500 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tUkUk-0002Qv-Sk for guix-patches@gnu.org; Mon, 06 Jan 2025 05:38:02 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:Date:From:To:In-Reply-To:References:Subject; bh=GXVKSVBSLWoSKRr7/3H1BUryjktwOuP12de7pkKtBAQ=; b=H40lu6v0N8k9Y1POq70ZTGBNdZ7ukJutgFSNrIiMhv+K4J6T4gLVTbOY8UgWPJLCzD2KZlw0tUaPrZ4+Rcpl7KY65UvqMsxnB8vgUgfhtTMNNB4bfxmB5GLJAhvvwi9fqubtBQfXAjc8Pum9l9nI/z2pJNjAIKftPmwDOHHfPUOR6pamdS3D2VYjCfi5j2WdJoyA6Bea67wAG72hYkrDn3Rl5XU+BpDyadus8agHG4wDrDDifITZcyTBi9ap2f5q5vINsQnhU1gcrBLq8hvnENMa+4UL+6Ruut3qKqDgcOmXtPgW/F3yIQepY064eslYzsM45+Yi8dVocWJoqd37vA==; Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1tUkUk-0003i9-Mq for guix-patches@gnu.org; Mon, 06 Jan 2025 05:38:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#74329] [PATCH v3 4/8] gnu: Replace quotations with texinfo markup in Haskell packages. References: In-Reply-To: Resent-From: Gabriel Wicki Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Mon, 06 Jan 2025 10:38:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 74329 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 74329@debbugs.gnu.org Cc: ludo@gnu.org Received: via spool by 74329-submit@debbugs.gnu.org id=B74329.173615985414193 (code B ref 74329); Mon, 06 Jan 2025 10:38:02 +0000 Received: (at 74329) by debbugs.gnu.org; 6 Jan 2025 10:37:34 +0000 Received: from localhost ([127.0.0.1]:36822 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tUkUH-0003gq-IH for submit@debbugs.gnu.org; Mon, 06 Jan 2025 05:37:34 -0500 Received: from cotopaxi.ee.ethz.ch ([129.132.148.196]:41683) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1tUkUF-0003gb-O9 for 74329@debbugs.gnu.org; Mon, 06 Jan 2025 05:37:32 -0500 Received: from localhost (antispam.ee.ethz.ch [129.132.2.16]) by cotopaxi.ee.ethz.ch (Postfix) with ESMTP id E95321FEFC; Mon, 6 Jan 2025 11:37:25 +0100 (CET) X-Virus-Scanned: by amavisd at antispam.ee.ethz.ch Received: from cotopaxi.ee.ethz.ch ([129.132.148.196]) by localhost (antispam.ee.ethz.ch [129.132.2.16]) (amavisd-new, port 10028) with ESMTP id GNfoM03uD_rs; Mon, 6 Jan 2025 11:37:22 +0100 (CET) Received: from blackbox (212-51-128-25.fiber7.init7.net [212.51.128.25]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (prime256v1) server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) (Authenticated sender: gabriel) by cotopaxi.ee.ethz.ch (Postfix) with ESMTPSA; Mon, 6 Jan 2025 11:37:22 +0100 (CET) From: Gabriel Wicki Date: Mon, 6 Jan 2025 11:19:05 +0100 Message-ID: <87cyh0qlct.fsf@erlikon.ch> MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * gnu/packages/haskell-check.scm (ghc-tasty-silver): Fix description. * gnu/packages/haskell-xyz.scm (ghc-hsyaml, ghc-regex-tdfa, ghc-rio, ghc-unsafe, ghc-mysql, ghc-witherable, ghc-random-bytestring, ghc-boring): Fix description. Change-Id: I63b9de3f7a3f360e84067898819cfcbc1b1b6fd4 --- gnu/packages/haskell-check.scm | 2 +- gnu/packages/haskell-xyz.scm | 64 +++++++++++++++++++--------------- 2 files changed, 37 insertions(+), 29 deletions(-) diff --git a/gnu/packages/haskell-check.scm b/gnu/packages/haskell-check.scm index e668706959..44da569bfa 100644 --- a/gnu/packages/haskell-check.scm +++ b/gnu/packages/haskell-check.scm @@ -1155,7 +1155,7 @@ (define-public ghc-tasty-silver "This package provides a fancy test runner and support for @dfn{golden testing}. A golden test is an IO action that writes its result to a file. To pass the test, this output file should be identical to the corresponding -``golden'' file, which contains the correct result for the test. The test +@emph{golden} file, which contains the correct result for the test. The test runner allows filtering tests using regexes, and to interactively inspect the result of golden tests.") (license license:expat))) diff --git a/gnu/packages/haskell-xyz.scm b/gnu/packages/haskell-xyz.scm index 0a58ee4d24..aa4c4b15f0 100644 --- a/gnu/packages/haskell-xyz.scm +++ b/gnu/packages/haskell-xyz.scm @@ -5792,7 +5792,7 @@ (define-public ghc-hsyaml representation (including support for cyclic YAML data structures). @item Support for the standard (untyped) @emph{Failsafe}, (strict) -@emph{JSON}, and (flexible) @emph{Core} ``schemas'' providing implicit +@emph{JSON}, and (flexible) @emph{Core} @code{schemas} providing implicit typing rules as defined in the YAML 1.2 specification (including support for user-defined custom schemas). @@ -10303,9 +10303,9 @@ (define-public ghc-regex-tdfa (home-page "https://wiki.haskell.org/Regular_expressions") (synopsis "POSIX extended regular expressions in Haskell") (description - "Regex-tdfa is a pure Haskell regular expression library implementing POSIX -extended regular expressions. It is a \"tagged\" DFA regex engine. It is -inspired by libtre.") + "Regex-tdfa is a pure Haskell regular expression library implementing +POSIX extended regular expressions. It is a @emph{tagged} DFA regex engine. +It is inspired by libtre.") (license license:bsd-3))) (define-public ghc-repline @@ -10506,7 +10506,7 @@ (define-public ghc-rio "This package works as a prelude replacement for Haskell, providing more functionality and types out of the box than the standard prelude (such as common data types like @code{ByteString} and -@code{Text}), as well as removing common ``gotchas'', like partial +@code{Text}), as well as removing common @emph{gotchas}, like partial functions and lazy I/O. The guiding principle here is: @itemize @item If something is safe to use in general and has no expected naming @@ -13695,7 +13695,7 @@ (define-public ghc-unsafe (home-page "https://hackage.haskell.org/package/unsafe") (synopsis "Unified interface to unsafe functions") (description "Safe Haskell introduced the notion of safe and unsafe -modules. In order to make as many as possible modules ``safe'', the +modules. In order to make as many as possible modules @emph{safe}, the well-known unsafe functions were moved to distinguished modules. This makes it hard to write packages that work with both old and new versions of GHC. This package provides a single module System.Unsafe that @@ -15391,7 +15391,7 @@ (define-public ghc-mysql most of the MySQL client API. The major departure from the C API is that in Haskell, resource management is mostly automatic and safe. -This library deliberately avoids the question of providing a ``good'' API. +This library deliberately avoids the question of providing a @emph{good} API. Its purpose is to serve as a base upon which higher-level libraries can be built.") (license license:bsd-3))) @@ -16153,8 +16153,8 @@ (define-public ghc-witherable (home-page "https://github.com/fumieval/witherable") (synopsis "Filterable traversable") (description - "This package provides a stronger variant of `traverse` which can remove elements -and generalised mapMaybe, catMaybes, filter") + "This package provides a stronger variant of @code{traverse} which can +remove elements and generalised mapMaybe, catMaybes, filter") (license license:bsd-3))) (define-public ghc-hspec-discover @@ -16263,22 +16263,29 @@ (define-public ghc-random-bytestring (home-page "https://www.github.com/larskuhtz/random-bytestring") (synopsis "Efficient generation of random bytestrings") (description - "__This package is deprecated__. Please, use genByteString from the [random -package (version >=1.2)](https://hackage.haskell.org/package/random) instead. . -Efficient generation of random bytestrings. The implementation populates -uninitialized memory with uniformily distributed random 64 bit words (and 8 bit -words for remaining bytes at the end of the bytestring). . Random words are -generated using the PRNG from the -[mwc-random](https://hackage.haskell.org/package/mwc-random) package or the -[pcg-random](https://hackage.haskell.org/package/pcg-random) package. It is -also possible to use a custom PRNG by providing an instance for the RandomWords -type class and using the function generate from the module -\"Data.ByteString.Random.Internal\". . The generated byte strings are suitable -for statistical applications. They are /not/ suitable for cryptographic -applications. . -![benchmarks](https://hackage.haskell.org/package/random-bytestring-0.1.3.2/src/benchmarks.png) -. ![detailed -benchmarks](https://hackage.haskell.org/package/random-bytestring-0.1.3.2/src/benchmarks-details.png)") + "@emph{This package is deprecated}. Please, use genByteString from the +@url{https://hackage.haskell.org/package/random,random package (version +>=1.2)]} instead. Efficient generation of random bytestrings. The +implementation populates uninitialized memory with uniformily distributed +random 64 bit words (and 8 bit words for remaining bytes at the end of the +bytestring). Random words are generated using the PRNG from the +@url{https://hackage.haskell.org/package/mwc-random, mwc-random} package or +the @url{https://hackage.haskell.org/package/pcg-random, pcg-random} package. +It is also possible to use a custom PRNG by providing an instance for the +RandomWords type class and using the function generate from the module +@code{Data.ByteString.Random.Internal}. The generated byte strings are +suitable for statistical applications. They are @emph{not} suitable for +cryptographic applications. +@itemize + +@item +@url{https://hackage.haskell.org/package/random-bytestring-0.1.3.2/src/benchmarks.png, +benchmarks} + +@item +@url{https://hackage.haskell.org/package/random-bytestring-0.1.3.2/src/benchmarks-details.png, +detailed benchmarks} +@end itemize") (license license:expat))) (define-public ghc-base64 @@ -16868,9 +16875,10 @@ (define-public ghc-boring (home-page "https://github.com/phadej/boring") (synopsis "Boring and Absurd types") (description - "* @@Boring@@ types are isomorphic to @@()@@. . * @@Absurd@@ types are isomorphic -to @@Void@@. . See [What does () mean in Haskell -answer by Conor -McBride](https://stackoverflow.com/questions/33112439/what-does-mean-in-haskell/33115522#33115522)") + "@itemize +@item @code{Boring} types are isomorphic to @code{()}. +@item @code{Absurd} types are isomorphic to @code{Void}. +@end itemize") (license license:bsd-3))) (define-public ghc-some