From patchwork Tue Oct 17 07:37:22 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Maxim Cournoyer X-Patchwork-Id: 54924 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 C15E827BBE2; Tue, 17 Oct 2023 08:38:51 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI, SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable 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 C9D8E27BBE9 for ; Tue, 17 Oct 2023 08:38:50 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qsef2-0002cb-Gc; Tue, 17 Oct 2023 03:38:40 -0400 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 1qsef1-0002Ve-2J for guix-patches@gnu.org; Tue, 17 Oct 2023 03:38:39 -0400 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 1qseez-00041W-5h; Tue, 17 Oct 2023 03:38:38 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qsefN-0006wf-Oo; Tue, 17 Oct 2023 03:39:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#66585] [PATCH] doc: Expound on the build-side versus host-side modules topic. Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: ludo@gnu.org, guix-patches@gnu.org Resent-Date: Tue, 17 Oct 2023 07:39:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 66585 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 66585@debbugs.gnu.org, maxim.cournoyer@gmail.com Cc: Ludovic =?utf-8?q?Court=C3=A8s?= , ludo@gnu.org X-Debbugs-Original-To: guix-patches@gnu.org, maxim.cournoyer@gmail.com X-Debbugs-Original-Xcc: ludo@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.169752828426615 (code B ref -1); Tue, 17 Oct 2023 07:39:01 +0000 Received: (at submit) by debbugs.gnu.org; 17 Oct 2023 07:38:04 +0000 Received: from localhost ([127.0.0.1]:58433 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qseeS-0006vC-2h for submit@debbugs.gnu.org; Tue, 17 Oct 2023 03:38:04 -0400 Received: from lists.gnu.org ([2001:470:142::17]:54532) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qseeP-0006uf-1A for submit@debbugs.gnu.org; Tue, 17 Oct 2023 03:38:02 -0400 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 1qsedu-0001De-0o for guix-patches@gnu.org; Tue, 17 Oct 2023 03:37:30 -0400 Received: from mail-qv1-xf2f.google.com ([2607:f8b0:4864:20::f2f]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qseds-0003po-EV; Tue, 17 Oct 2023 03:37:29 -0400 Received: by mail-qv1-xf2f.google.com with SMTP id 6a1803df08f44-66cfd0b2d58so35315566d6.2; Tue, 17 Oct 2023 00:37:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1697528246; x=1698133046; darn=gnu.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=pFa9gwiVESiO2KwRF+/KZxBvg89n6yts68exkSVG4bo=; b=RlXHHn5FdMk54Q85SLXInR66+mbREPzmOKcVf/JQFM2UPNX+5cPK8VFjh8npQuTNjw Z5qydOd76JG8yGxNB8bkS4XiGMstc3QUjuRBfAmKk/jE9SMUw3ZUywZ0Ugyo0ZouCOA5 VrAY0PhRgxspS2WtDnqXqLq1gdWAq5XlYQf1qKlUvee9CORL3rkF88Ns1hfC5p8o7eMb tM0MowMROjeVPaZcnqmXod1/r4DbOu5pVT/+9gcQ5vZVMgKnJ/kpTDDw4hRO+Ft9es95 WxGPihNrkad9xabrAUawqyDNDJMYXbicakIUXmpkvl5Ki7DzgDSxXzSRvpibepyJp3Gn 8zNg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1697528246; x=1698133046; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=pFa9gwiVESiO2KwRF+/KZxBvg89n6yts68exkSVG4bo=; b=ExWholLiI/7TF9edlWyUzIyIesIeYISR8VnZCkle5En0Se8bYwRc9jbnaFYg+QtEgI LxSDifrY1GbP8p/EeteXCgOS/9Qy776yTeY6hUvipGnlPtr1PvZx0UOGfsCqvd8QDitj gQznhM/ZnjFbr7MPMwyjXUJgOlNnf5I/l+aVkbPyrnFgBktlcmndTlV8hFcxFBoYl3Yp EuAWdhevmKj+CXuKajWoDcUPue1xjECJ0VaN8jHQbRYsAlt7k8TkrYOxgCn4M/ACSHLg SL6U4clEoZlpWEbyLT/MXaZtgQiy6jvWytK5fSd0AztMLL9Nuk3CGRGH2CcCVJ1j4WYQ p53w== X-Gm-Message-State: AOJu0Yy4oXb7IT2d+Csve5kbVipTWottpq8YgBxerr4AVIsVel9oMY6g fK9GcIV6BxCxOyWcSGdx6ees2Mwu/rGBoQ== X-Google-Smtp-Source: AGHT+IHKBzr2AZOdIl4cIw77QYgf2GTC/UrIO8JnDNzExpPzNGOjA9v+6u/N/4a43V9SysePGuW+0w== X-Received: by 2002:ad4:5746:0:b0:663:95d0:a50b with SMTP id q6-20020ad45746000000b0066395d0a50bmr1898197qvx.30.1697528245843; Tue, 17 Oct 2023 00:37:25 -0700 (PDT) Received: from localhost.localdomain (dsl-10-149-74.b2b2c.ca. [72.10.149.74]) by smtp.gmail.com with ESMTPSA id u12-20020a0ced2c000000b0064f4ac061b0sm346582qvq.12.2023.10.17.00.37.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 17 Oct 2023 00:37:25 -0700 (PDT) From: Maxim Cournoyer Date: Tue, 17 Oct 2023 03:37:22 -0400 Message-ID: X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 Received-SPF: pass client-ip=2607:f8b0:4864:20::f2f; envelope-from=maxim.cournoyer@gmail.com; helo=mail-qv1-xf2f.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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 Discussed in . * doc/contributing.texi (Modules): Add new context indices, and provide a real-life counter-example, and its ramifications. Reported-by: Ludovic Courtès Change-Id: I06975fb24f0d67c833884313a727dc550f61d8a0 --- doc/contributing.texi | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) base-commit: ff11cbc2e9589bcb98eb9cad1704b4b991d6f20e diff --git a/doc/contributing.texi b/doc/contributing.texi index 864190b119..be159e237e 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -1279,14 +1279,19 @@ Programming Paradigm @node Modules @subsection Modules - +@cindex build-side modules +@cindex host-side modules Guile modules that are meant to be used on the builder side must live in the @code{(guix build @dots{})} name space. They must not refer to other Guix or GNU modules. However, it is OK for a ``host-side'' module -to use a build-side module. +to use a build-side module. As an example, the @code{(guix +search-paths)} module should not be imported and used by a package since +it isn't meant to be used as a ``build-side'' module. It would also +couple the module with the package's dependency graph, which is +undesirable. Modules that deal with the broader GNU system should be in the -@code{(gnu @dots{})} name space rather than @code{(guix @dots{})}. +@code{(gnu @dots{})} name space rather than @code{(guix @dots{})} @node Data Types and Pattern Matching @subsection Data Types and Pattern Matching