From patchwork Sat Nov 19 22:24:51 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Ludovic_Court=C3=A8s?= X-Patchwork-Id: 44687 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 1DDC727BBED; Sat, 19 Nov 2022 22:26:28 +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=-3.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H2,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 8507A27BBE9 for ; Sat, 19 Nov 2022 22:26:27 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1owWHu-0007Jy-5w; Sat, 19 Nov 2022 17:26:14 -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 1owWHi-0007JF-Av for guix-patches@gnu.org; Sat, 19 Nov 2022 17:26:03 -0500 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1owWHi-0004SY-2y for guix-patches@gnu.org; Sat, 19 Nov 2022 17:26:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1owWHh-0004gf-Ud for guix-patches@gnu.org; Sat, 19 Nov 2022 17:26:01 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#59390] [PATCH 2/5] doc: Recommend 'match-record'. Resent-From: Ludovic =?utf-8?q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 19 Nov 2022 22:26:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 59390 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 59390@debbugs.gnu.org Cc: Ludovic =?utf-8?q?Court=C3=A8s?= Received: via spool by 59390-submit@debbugs.gnu.org id=B59390.166889673117924 (code B ref 59390); Sat, 19 Nov 2022 22:26:01 +0000 Received: (at 59390) by debbugs.gnu.org; 19 Nov 2022 22:25:31 +0000 Received: from localhost ([127.0.0.1]:41583 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1owWHD-0004f1-53 for submit@debbugs.gnu.org; Sat, 19 Nov 2022 17:25:31 -0500 Received: from eggs.gnu.org ([209.51.188.92]:58074) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1owWHB-0004ei-RU for 59390@debbugs.gnu.org; Sat, 19 Nov 2022 17:25:30 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1owWH6-0004Je-Ky; Sat, 19 Nov 2022 17:25:24 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:References:In-Reply-To:Date:Subject:To: From; bh=20GcEvWOA08GTJKOhrNIiaAgeo7tfeOB7qBBrezc5Hg=; b=R0HWUUH+aD4Sv6k0Lf+4 3Q1gepytSsYCmspEyXKJOGAjrwf04rvFNzPlzComeqqOcUdwJQ7HsoIiVZ7a9Cys9Yo5luzZrmHcG q9ibJYVTw/m+Pe+FDnTRGIpdIgq9/+YUPyTgYMBHzyg6brngTMyOuVjLtYAZ2Wr9wBSK1zgGXUs88 trtyNj/hTgvVC6Jg/BaJEzO+2M3kc/T/Grv2NNi9gc6VYu2UGAGCadjqE8z18nkFSgIC64ohKd3XB dhAfiddw/3ZZdqGWlujkePJ1No1Rujz6cm2gCmJffoL4SdUPqM40akkt+BeVvFbXJy2mtSsHFrwv8 cRcd5Zh4LqWk6Q==; Received: from 91-160-117-201.subs.proxad.net ([91.160.117.201] helo=gnu.org) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1owWGk-0006LD-Td; Sat, 19 Nov 2022 17:25:03 -0500 From: Ludovic =?utf-8?q?Court=C3=A8s?= Date: Sat, 19 Nov 2022 23:24:51 +0100 Message-Id: <20221119222454.10759-2-ludo@gnu.org> X-Mailer: git-send-email 2.38.1 In-Reply-To: <20221119222454.10759-1-ludo@gnu.org> References: <20221119222454.10759-1-ludo@gnu.org> 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 * doc/contributing.texi (Data Types and Pattern Matching): Recommend 'match-record'. --- doc/contributing.texi | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/contributing.texi b/doc/contributing.texi index 40ae33ecac..6a8ffd6524 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -1089,11 +1089,16 @@ and then to browse them ``by hand'' using @code{car}, @code{cdr}, notably the fact that it is hard to read, error-prone, and a hindrance to proper type error reports. +@findex define-record-type* +@findex match-record +@cindex pattern matching Guix code should define appropriate data types (for instance, using @code{define-record-type*}) rather than abuse lists. In addition, it should use pattern matching, via Guile’s @code{(ice-9 match)} module, especially when matching lists (@pxref{Pattern Matching,,, guile, GNU -Guile Reference Manual}). +Guile Reference Manual}); pattern matching for records is better done +using @code{match-record} from @code{(guix records)}, which, unlike +@code{match}, verifies field names at macro-expansion time. @node Formatting Code @subsection Formatting Code