unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: "Ludovic Courtès" <ludo@gnu.org>
To: zimoun <zimon.toutoune@gmail.com>
Cc: 43482@debbugs.gnu.org
Subject: [bug#43482] [PATCH 3/3] doc: Reorder the "Channels" section.
Date: Thu, 24 Sep 2020 16:59:39 +0200	[thread overview]
Message-ID: <874knn8bl0.fsf@gnu.org> (raw)
In-Reply-To: <20200918014502.6081-3-zimon.toutoune@gmail.com> (zimoun's message of "Fri, 18 Sep 2020 03:45:02 +0200")

zimoun <zimon.toutoune@gmail.com> skribis:

> * doc/guix.texi (Channels): Reorder the section.
> Minor tweaks to keep uniformity.
> Update the master menu.

It would be nice if you could better describe what’s moved where since
looking at the diff doesn’t help understand it.

> +@node Writing custom channels
> +@subsection Writing custom channels

Should be “Writing Custom Channels”.

Maybe “Creating a Channel” is more to the point actually?

>  To create a channel, create a Git repository containing your own package
>  modules and make it available.  The repository can contain anything, but a
>  useful channel will contain Guile modules that export packages.  Once you
> @@ -4398,6 +4470,24 @@ module, then the module will be available under the name @code{(my-packages
>  my-tools)}, and you will be able to use it like any other module
>  (@pxref{Modules,,, guile, GNU Guile Reference Manual}).
>  
> +Last, as a channel author, you may want to run an authenticated channel
> +(@pxref{Channel Authentication}), then @pxref{Specifying Channel
> +Authorizations} for details.

Maybe something like:

  As a channel author, consider bundling authentication material with
  your channel so that users can authenticate it.  @xref{Channel
  Authentication}, and @ref{Specifying Channel Authorizations}, for
  info on how to do it.

(Note: @pxref cannot be used in the middle of a sentence like you did
above.  I always end up re-reading the Texinfo manual to find which
cross-reference command to use in which context…)

Could you send updated patches?

Thanks!

Ludo’.




  reply	other threads:[~2020-09-24 15:00 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-18  1:37 [bug#43482] [PATCH 0/3] doc: Reorder "Channels" section zimoun
2020-09-18  1:45 ` [bug#43482] [PATCH 1/3] doc: Update the master menu zimoun
2020-09-18  1:45   ` [bug#43482] [PATCH 2/3] doc: Add the "Channels" section menu zimoun
2020-09-24 14:52     ` Ludovic Courtès
2020-09-24 15:05       ` zimoun
2020-09-25  9:20         ` Ludovic Courtès
2020-09-18  1:45   ` [bug#43482] [PATCH 3/3] doc: Reorder the "Channels" section zimoun
2020-09-24 14:59     ` Ludovic Courtès [this message]
2020-09-24 15:13       ` zimoun
2020-09-24 14:51   ` [bug#43482] [PATCH 1/3] doc: Update the master menu Ludovic Courtès
2020-09-24 15:28     ` zimoun
2020-09-25 20:00 ` [bug#43482] [PATCH v2 1/2] " zimoun
2020-09-25 20:00   ` [bug#43482] [PATCH v2 2/2] doc: Promote "Channels" as chapter and reorder zimoun
2020-09-27 20:38   ` bug#43482: [PATCH v2 1/2] doc: Update the master menu 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=874knn8bl0.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=43482@debbugs.gnu.org \
    --cc=zimon.toutoune@gmail.com \
    /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).