unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: jgart via Guix-patches via <guix-patches@gnu.org>
To: 60630@debbugs.gnu.org
Cc: jgart <jgart@dismail.de>
Subject: [bug#60630] [PATCH] guix: channels: Add description field.
Date: Sat,  7 Jan 2023 10:24:31 -0600	[thread overview]
Message-ID: <20230107162431.6739-1-jgart@dismail.de> (raw)

* guix/channels.scm (<channel>): Add channel description field and
comment disambiguating the type expected in an introduction field.
* doc/guix.scm (Invoking guix describe): Add channel description field
to channels record instance example.

This commit adds an optional description field to a channel intended to
describe the channel. Its purpose is similar to the description field
in a <package> record.
---
 doc/guix.texi     |  2 ++
 guix/channels.scm | 15 ++++++++-------
 2 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 24d99cbf24..483d2fbaa4 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -5063,6 +5063,8 @@ $ guix describe -f channels
 (list (channel
         (name 'guix)
         (url "https://git.savannah.gnu.org/git/guix.git")
+        (description "The main GNU Guix channel providing the core
+package collection along with Guix and its documentation.")
         (commit
           "e0fa68c7718fffd33d81af415279d6ddb518f727")
         (introduction
diff --git a/guix/channels.scm b/guix/channels.scm
index d84228c47e..8acf3d8742 100644
--- a/guix/channels.scm
+++ b/guix/channels.scm
@@ -122,13 +122,14 @@ (define-module (guix channels)
 
 (define-record-type* <channel> channel make-channel
   channel?
-  (name      channel-name)
-  (url       channel-url)
-  (branch    channel-branch (default "master"))
-  (commit    channel-commit (default #f))
-  (introduction channel-introduction (default #f))
-  (location  channel-location
-             (default (current-source-location)) (innate)))
+  (name              channel-name)
+  (url               channel-url)
+  (description       channel-description (default #f)) ; string
+  (branch            channel-branch (default "master"))
+  (commit            channel-commit (default #f))
+  (introduction      channel-introduction (default #f)) ; <channel-introduction>
+  (location          channel-location
+                     (default (current-source-location)) (innate)))
 
 ;; Channel introductions.  A "channel introduction" provides a commit/signer
 ;; pair that specifies the first commit of the authentication process as well
-- 
2.38.1





             reply	other threads:[~2023-01-07 16:25 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-07 16:24 jgart via Guix-patches via [this message]
2023-01-08 15:43 ` [bug#60630] [PATCH] guix: channels: Add description field Liliana Marie Prikler
2023-01-09 16:25   ` Ludovic Courtès
2023-01-10  2:38   ` jgart via Guix-patches via
2023-01-10  9:50     ` Ludovic Courtès

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230107162431.6739-1-jgart@dismail.de \
    --to=guix-patches@gnu.org \
    --cc=60630@debbugs.gnu.org \
    --cc=jgart@dismail.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).