From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id mE0hNTM672VOvgAA62LTzQ:P1 (envelope-from ) for ; Mon, 11 Mar 2024 18:07:00 +0100 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1.migadu.com with LMTPS id mE0hNTM672VOvgAA62LTzQ (envelope-from ) for ; Mon, 11 Mar 2024 18:07:00 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gnu.org header.s=fencepost-gnu-org header.b=Ojkd5485; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gnu.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1710176819; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:resent-cc:resent-from:resent-sender: resent-message-id:in-reply-to:in-reply-to:references:references: list-id:list-help:list-unsubscribe:list-subscribe:list-post: dkim-signature; bh=gtk2KRS5zYyZiu5N2QWK7JIc+eztXHbFKx40OaRr+Ck=; b=OASq3YEizmyUIh7AXKJgcMdsp05tOaAOGTVVLgNmmvxHf3xqmvmRURMmd4nCMWgipp+3Xm LArphoU1Tlab/NmP1i6EMBtN8om0RK+qeidMhIfmozFyuIXdtYZrf9Ss8Poe9wojcSbE35 tMwWX5oABb0krs1/OquV+DHWPiJFUKXUsSbMnoHUJkuIqSoBaYBFhvobaJJ6Lrlxv/vz+v CesAs8hmIIM65oMecp4S9liDALM9MB3Of9fCMrleff4jbNXryGRVlFWafjTgm5hilUl8QG XunLFN1SWcxhnBgJs5rMhsmroz4+Fpef7huARHyPQOJ4nX1cg6Lax2Qz7t1+5g== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gnu.org header.s=fencepost-gnu-org header.b=Ojkd5485; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gnu.org ARC-Seal: i=1; s=key1; d=yhetil.org; t=1710176819; a=rsa-sha256; cv=none; b=XcDXJmPvYCX6BlQ4YPQsEg7JfZJrdEXha1vFTnQ3EVZHto0MfOBSStEHfLZFQKg7k6bQ0H UK4dHPJHv2ikzyPuBdro78q9A3hlfOJT/gPgxGNEP3bq7iVfBNcmgfHGf44nOwueJwydKa qzTM5fHK3YB9Y57Pcs0SrRpyP07/bkU3S9sFkmrBMNy300YtBgMzRKxjXueo4nq7s31n95 vW7LqV6ToGB7fn4OZHZTFyy3KOUHNYcX2XBlWDg2DxyIdwtJgDEiwdzS3V0U2BeVXCDBG2 TSYp+eR0jKopcmjq2jImwpIhRrZaCytU7UKDP84k+1hg9R9l60xyDdtvsJW1LA== Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 8DFD51138C for ; Mon, 11 Mar 2024 18:06:59 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rjj6i-0001d5-CF; Mon, 11 Mar 2024 13:06:36 -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 1rjj6a-0001cc-5C for guix-patches@gnu.org; Mon, 11 Mar 2024 13:06:33 -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 1rjj6Z-00084Z-RZ for guix-patches@gnu.org; Mon, 11 Mar 2024 13:06:27 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rjj77-0007PI-PF for guix-patches@gnu.org; Mon, 11 Mar 2024 13:07:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#69587] [PATCH] doc: Add =?UTF-8?Q?=E2=80=9CSource?= Tree =?UTF-8?Q?Structure=E2=80=9D?= section. Resent-From: Ludovic =?UTF-8?Q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Mon, 11 Mar 2024 17:07:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 69587 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: "pelzflorian (Florian Pelz)" Cc: 69587@debbugs.gnu.org Received: via spool by 69587-submit@debbugs.gnu.org id=B69587.171017677828416 (code B ref 69587); Mon, 11 Mar 2024 17:07:01 +0000 Received: (at 69587) by debbugs.gnu.org; 11 Mar 2024 17:06:18 +0000 Received: from localhost ([127.0.0.1]:41164 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rjj6Q-0007OE-8c for submit@debbugs.gnu.org; Mon, 11 Mar 2024 13:06:18 -0400 Received: from eggs.gnu.org ([209.51.188.92]:41758) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rjj6N-0007Nk-B4 for 69587@debbugs.gnu.org; Mon, 11 Mar 2024 13:06:17 -0400 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 1rjj5h-0007rJ-Op; Mon, 11 Mar 2024 13:05:35 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:Date:References:In-Reply-To:Subject:To: From; bh=gtk2KRS5zYyZiu5N2QWK7JIc+eztXHbFKx40OaRr+Ck=; b=Ojkd5485LtmW+Hbkg0OM AMCLWEEihmw8EUrAko/y1/QSo3EaSbOSOwoNHS+3o9Qm0e7XD0wCyaIhqMFWeRNJhKcFFoUs3+pij uryKQ08lmZFasNo808u8GHCYZQjxzu+vaJfhOd+pnr4cowfKJNjjmC9AX+iUyYgbJE1fr+tRawcaN EablnXgVoNxOUGSR51wp5vS//oY6BZgZiRPM5eXTG604aB94pybEyloXXqGwDls4Q8IQF5S6dV098 e5Gvz1yf9WL6RuKbFkS/w5rAmaXQVhprdQ0hSOSg/Ykx8+wBYnp5UEwMfnWu1RH44weS41bzsZEvx ZEQIr9ojiLMDig==; From: Ludovic =?UTF-8?Q?Court=C3=A8s?= In-Reply-To: <878r2r8o7f.fsf@pelzflorian.de> (pelzflorian@pelzflorian.de's message of "Sat, 09 Mar 2024 15:38:44 +0100") References: <878r2sa9hd.fsf@pelzflorian.de> <877cic2xa6.fsf@gnu.org> <878r2r8o7f.fsf@pelzflorian.de> Date: Mon, 11 Mar 2024 18:05:12 +0100 Message-ID: <87le6oog1j.fsf@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" 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+larch=yhetil.org@gnu.org Sender: guix-patches-bounces+larch=yhetil.org@gnu.org X-Migadu-Country: US X-Migadu-Flow: FLOW_IN X-Migadu-Scanner: mx12.migadu.com X-Migadu-Spam-Score: -7.18 X-Spam-Score: -7.18 X-Migadu-Queue-Id: 8DFD51138C X-TUID: q9F8PmYyefYY --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Hello! "pelzflorian (Florian Pelz)" skribis: > Josselin=E2=80=99s talk is different in that it is a talk of more than 30 > minutes. In so much time, it can give more detailed guidance to almost > the whole guix source tree, even including build-aux and nix. Josselin > also gives hints to use git grep (like you) but also to read the > commentary at the top of the file. This may be a helpful hint to > someone starting out, but someone starting out maybe does not want to > read as much as a complete talk. If they wanted it all, then better > link to Josselin=E2=80=99s talk. Right. > Ludovic Court=C3=A8s writes: >> The order I chose is (roughly) from lower-level to higher-level: >> >> (guix store) -> (guix derivation) -> (guix packages) -> =E2=80=A6 >> =E2=80=A6 -> (gnu packages) -> (gnu system) -> =E2=80=A6 >> >> Does that make sense? > > In your section the modules directly in (guix =E2=80=A6) appeared unsorte= d to > me. Could you explicitly state this order in the manual section? Good idea, will do. > Nice things like (guix swh) or (gnu system), (gnu build), (gnu > installer), (gnu machine), or po, still seem not useful for the general > populace to me. This is in the =E2=80=9CContributing=E2=80=9D chapter, so we=E2=80=99re tal= king about a subset of the general populace. :-) You might argue that few current contributors care about the modules you mention, but by exposing the structure of the code, my hope is that more people would dare take a look and fiddle with it. [...] >> The examples were meant to illustrate what is meant by =E2=80=9Ccore=E2= =80=9D. Do you >> think some other adjective or a longer description would help? >> >>> Perhaps (guix =E2=80=A6) should be listed after (gnu =E2=80=A6) and de= fined as the >>> Guix mechanisms that do not belong in gnu? Not quite sure either. > > Josselin called the distinction between (guix =E2=80=A6) and (gnu =E2=80= =A6) murky, > explaining that most of (guix =E2=80=A6) must not import (gnu =E2=80=A6) = except by > module-ref, while (guix scripts =E2=80=A6) and such can just use-modules = (gnu > =E2=80=A6). To me, gnu/packages.scm looks like core as well, but it righ= tfully > is in gnu. I think =E2=80=9Cmurky=E2=80=9D is a strong word, or at least it shouldn=E2= =80=99t be interpreted as meaning that the guix/gnu distinction is arbitrary. I=E2=80= =99ll try to clarify that as well. I was going to send a v2 but I=E2=80=99m not sure the changes I made fully address your concerns: --=-=-= Content-Type: text/x-patch Content-Disposition: inline diff --git a/doc/contributing.texi b/doc/contributing.texi index ff7065ad2a..18f3705a43 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -563,7 +563,9 @@ Source Tree Structure @table @file @item guix -This is the location of core Guix mechanisms. A few examples: +This is the location of core Guix mechanisms. To illustrate what is +meant by ``core'', here are a few examples, starting from low-level +tools and going towards higher-level tools: @table @code @item (guix store) @@ -638,10 +640,16 @@ Source Tree Structure @end table The directories we have seen so far all live under @file{guix/}. The -other important place is the @code{gnu/} directory, which contains +other important place is the @file{gnu/} directory, which contains primarily package definitions as well as libraries and tools for Guix System (@pxref{System Configuration}) and Guix Home (@pxref{Home -Configuration}). +Configuration}), all of which build upon functionality provided by +@code{(guix @dots{})} modules@footnote{For this reason, @code{(guix +@dots{})} modules must generally not depend on @code{(gnu @dots{})} +modules, with one notable exception: @code{(guix build-system @dots{})} +modules may look up packages at run time---e.g., @code{(guix +build-system cmake)} needs to access the @code{cmake} variable at run +time.}. @table @file @cindex package modules --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Let me know what you think! Thanks, Ludo=E2=80=99. --=-=-=--