From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id oA98OIURZF89fgAA0tVLHw (envelope-from ) for ; Fri, 18 Sep 2020 01:46:45 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id KK2rM4URZF+maAAAB5/wlQ (envelope-from ) for ; Fri, 18 Sep 2020 01:46:45 +0000 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 896E3940142 for ; Fri, 18 Sep 2020 01:46:45 +0000 (UTC) Received: from localhost ([::1]:47258 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kJ5U4-0004me-I3 for larch@yhetil.org; Thu, 17 Sep 2020 21:46:44 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:56246) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kJ5TO-0004eC-N2 for guix-patches@gnu.org; Thu, 17 Sep 2020 21:46:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:56872) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kJ5TO-0004vo-Do for guix-patches@gnu.org; Thu, 17 Sep 2020 21:46:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kJ5TO-00038N-CB for guix-patches@gnu.org; Thu, 17 Sep 2020 21:46:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#43482] [PATCH 2/3] doc: Add the "Channels" section menu. Resent-From: zimoun Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Fri, 18 Sep 2020 01:46:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 43482 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 43482@debbugs.gnu.org Cc: zimoun Received: via spool by 43482-submit@debbugs.gnu.org id=B43482.160039351811974 (code B ref 43482); Fri, 18 Sep 2020 01:46:02 +0000 Received: (at 43482) by debbugs.gnu.org; 18 Sep 2020 01:45:18 +0000 Received: from localhost ([127.0.0.1]:40181 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kJ5Sf-00036y-LV for submit@debbugs.gnu.org; Thu, 17 Sep 2020 21:45:18 -0400 Received: from mail-wm1-f46.google.com ([209.85.128.46]:50976) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kJ5Se-00036e-8P for 43482@debbugs.gnu.org; Thu, 17 Sep 2020 21:45:16 -0400 Received: by mail-wm1-f46.google.com with SMTP id e17so3733662wme.0 for <43482@debbugs.gnu.org>; Thu, 17 Sep 2020 18:45:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Q0Kcw/1ioIETOFFX8GR8DtbvqjsEYe8NDJlFGi69hKA=; b=YvnHN6VtnSXAdEgeJOnlILs8E50iEJKW9ZUrZjherZ14S2XroZNrNHJPp/kf8rbvne 3z3TUox5unVBHWGPUtB66WLHPFDZObg9uj7CKaArSdqYIo4FS4UBeNzRjFgb6Gc/+Qmf DwmidQ/O3IDO13uWcjM3Waw6W/FJzZTZGdppJmVSFhdgjGIgeXZgsTaOKPokK8TAkGxs 74tDy1WvGvAAy6bNStRVUE4LMmi/YSZZo9kYvsMFpvp4jfQNkJsHOk3ay7oFruzqIAxs TehwFIWeAXoKzLwW1ntZjgLkTYvCt8HN5mziOdjoR8j5xFibZSFl/TekqwceLk3K7EZI v22g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Q0Kcw/1ioIETOFFX8GR8DtbvqjsEYe8NDJlFGi69hKA=; b=iExt6M7ossut82fcYetAkOhqTSnQNs4/tRYkeARCr36uBSLCaDcrW7Rv0zOHQkGqrA Ls3J6gPQ1hI1CWymlnFr/5HABxmN0DwjZa1HTPp7oY7Pe2pyS7IcX1JtRwF0XMJKJzTJ l2VejAPGksZDZOxC2779o78aexPvgWypMRVUXs8EzwzmQCTjRVX+Wo04BF12hP57Iaqd k4oJcF/ta5dzUj5CuQ8FD5PXQtREwpkEKO5dKdj/Fmv8fz0iG+Xrg+23xz5/cX7V1q0p pr6h8pbW4nUeKtmzql7KZWR7WqMPVQgP67FCQTTQvHYKNxTmQAa2x5xRisKO29+IhLYI nxsA== X-Gm-Message-State: AOAM530Ft36xSd2i0oW82PCOQyR+escyO2IXqVSkhKFZdnEnMcb95GJ4 TjnGq236AJRpF53SdfrHu45eH2VEHjw= X-Google-Smtp-Source: ABdhPJzTxIaOufMv7F9OYmiebk3vFp+Pcj0hhmGhz4A5XV16RvdxqYbwL19iAxHObSpe0Gf6fePStQ== X-Received: by 2002:a1c:40c6:: with SMTP id n189mr12680009wma.48.1600393510261; Thu, 17 Sep 2020 18:45:10 -0700 (PDT) Received: from lili.univ-paris-diderot.fr ([88.126.110.68]) by smtp.gmail.com with ESMTPSA id q15sm2144919wrr.8.2020.09.17.18.45.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 17 Sep 2020 18:45:09 -0700 (PDT) From: zimoun Date: Fri, 18 Sep 2020 03:45:01 +0200 Message-Id: <20200918014502.6081-2-zimon.toutoune@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20200918014502.6081-1-zimon.toutoune@gmail.com> References: <20200918014502.6081-1-zimon.toutoune@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-Spam-Score: -1.0 (-) 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" X-Scanner: scn0 Authentication-Results: aspmx1.migadu.com; dkim=fail (rsa verify failed) header.d=gmail.com header.s=20161025 header.b=YvnHN6Vt; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Spam-Score: 4.09 X-TUID: F7zSx4zVI2c3 * doc/guix.texi (Channels): Add the section menu. --- doc/guix.texi | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/doc/guix.texi b/doc/guix.texi index 5a1f2e3bc3..f30faf257a 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -226,6 +226,18 @@ Substitutes * Substitution Failure:: What happens when substitution fails. * On Trusting Binaries:: How can you trust that binary blob? +Channels + +* Channel Authentication:: How Guix verifies what it fetches. +* Using a Custom Guix Channel:: Using a customized Guix. +* Specifying Additional Channels:: Extending the package collection. +* Declaring Channel Dependencies:: Declaring channel dependencies. +* Package Modules in a Sub-directory:: Package Modules in a Sub-directory. +* Specifying Channel Authorizations:: Specifying Channel Authorizations. +* Primary URL:: Distinguishing mirror to original. +* Writing Channel News:: Communicating information to channel's users. +* Replicating Guix:: Running the @emph{exact same} Guix. + Development * Invoking guix environment:: Setting up development environments. @@ -4206,6 +4218,19 @@ to pull from one or more channels. In other words, channels can be used to @emph{customize} and to @emph{extend} Guix, as we will see below. Before that, some security considerations. +@menu +* Channel Authentication:: How Guix verifies what it fetches. +* Using a Custom Guix Channel:: Using a customized Guix. +* Specifying Additional Channels:: Extending the package collection. +* Declaring Channel Dependencies:: Declaring channel dependencies. +* Package Modules in a Sub-directory:: Package Modules in a Sub-directory. +* Specifying Channel Authorizations:: Specifying Channel Authorizations. +* Primary URL:: Distinguishing mirror to original. +* Writing Channel News:: Communicating information to channel's users. +* Replicating Guix:: Running the @emph{exact same} Guix. +@end menu + +@node Channel Authentication @subsection Channel Authentication @anchor{channel-authentication} @@ -4245,6 +4270,7 @@ introduction from a trusted source since that is the root of your trust. If you're curious about the authentication mechanics, read on! +@node Using a Custom Guix Channel @subsection Using a Custom Guix Channel The channel called @code{guix} specifies where Guix itself---its command-line @@ -4265,6 +4291,7 @@ write in @code{~/.config/guix/channels.scm} this specification: From there on, @command{guix pull} will fetch code from the @code{super-hacks} branch of the repository at @code{example.org}. +@node Specifying Additional Channels @subsection Specifying Additional Channels @cindex extending the package collection (channels) @@ -4373,6 +4400,7 @@ my-tools)}, and you will be able to use it like any other module @cindex dependencies, channels @cindex meta-data, channels +@node Declaring Channel Dependencies @subsection Declaring Channel Dependencies Channel authors may decide to augment a package collection provided by other @@ -4413,6 +4441,7 @@ on channels that you don't control, and you should aim to keep the number of dependencies to a minimum. @cindex subdirectory, channels +@node Package Modules in a Sub-directory @subsection Package Modules in a Sub-directory As a channel author, you may want to keep your channel modules in a @@ -4426,6 +4455,7 @@ add a meta-data file @file{.guix-channel} that contains: @end lisp @cindex channel authorizations +@node Specifying Channel Authorizations @subsection Specifying Channel Authorizations @anchor{channel-authorizations} @@ -4526,6 +4556,7 @@ are considered authentic if and only if they are signed by a key present in the @file{.guix-authorizations} file of @emph{both} branches. @cindex primary URL, channels +@node Primary URL @subsection Primary URL Channel authors can indicate the primary URL of their channel's Git @@ -4548,6 +4579,7 @@ the official @code{guix} channel, for which @command{guix pull} ensures the code it fetches is authentic. @cindex news, for channels +@node Writing Channel News @subsection Writing Channel News Channel authors may occasionally want to communicate to their users @@ -4615,6 +4647,7 @@ xgettext -o news.po -l scheme -ken etc/news.txt To sum up, yes, you could use your channel as a blog. But beware, this is @emph{not quite} what your users might expect. +@node Replicating Guix @subsection Replicating Guix @cindex pinning, channels -- 2.28.0