unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: zimoun <zimon.toutoune@gmail.com>
To: Guix Devel <guix-devel@gnu.org>
Subject: doc: Channel subsection order?
Date: Sat, 12 Sep 2020 00:49:34 +0200	[thread overview]
Message-ID: <CAJ3okZ2i7hBOQaME=P4yLBQPYx3WH=W6i4JNKzq-51xLu9-jRQ@mail.gmail.com> (raw)

Dear,

I was re-reading the section about Channels and the subsections do not
appear to me "logical".  Currently, it is:

  1. Channel Authentication
  2. Using a Custom Guix Channel
  3. Specifying Additional Channels
  4. Declaring Channel Dependencies
  5. Package Modules in a Sub-directory
  6. Specifying Channel Authorizations
  7. Primary URL
  8. Writing Channel News
  9. Replicating Guix

and to me, the progression when reading is smoother with this order:

  1. Using a Custom Guix Channel
  2. Specifying Additional Channels
  3. Channel Authentication
  4. Declaring Channel Dependencies
  etc.

The examples read more naturally:

#1
     ;; Tell 'guix pull' to use my own repo.
     (list (channel
             (name 'guix)
             (url "https://example.org/my-guix.git")
             (branch "super-hacks")))

#2
     ;; Add my personal packages to those Guix provides.
     (cons (channel
             (name 'my-personal-packages)
             (url "https://example.org/personal-packages.git"))
           %default-channels)

#3
     (channel
       (name 'my-channel)
       (url "https://example.org/my-channel.git")
       (introduction
        (make-channel-introduction
         "6f0d8cc0d88abb59c324b2990bfee2876016bb86"
         (openpgp-fingerprint
          "CABB A931 C0FF EEC6 900D  0CFB 090B 1199 3D9A EBB5"))))

than: starts by #3 and goes to #1 after.

Other said, starting by Authentication gives the false impression that
Channels have to be authenticated (with gpg keys and so on); which
means (at least to me): it is complicated.  And it is not, both:
necessarily authenticated and complicated. : -)

All the best,
simon


             reply	other threads:[~2020-09-11 22:50 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-11 22:49 zimoun [this message]
2020-09-12 10:14 ` doc: Channel subsection order? Pierre Neidhardt
2020-09-16 16:39 ` Ludovic Courtès
2020-09-16 18:58   ` zimoun
2020-09-18  1:44   ` zimoun
2020-09-18 12:19     ` Ludovic Courtès
2020-09-18 20:12       ` zimoun

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='CAJ3okZ2i7hBOQaME=P4yLBQPYx3WH=W6i4JNKzq-51xLu9-jRQ@mail.gmail.com' \
    --to=zimon.toutoune@gmail.com \
    --cc=guix-devel@gnu.org \
    /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).