GNU bug report logs - #43482
[PATCH 0/3] doc: Reorder "Channels" section

Previous Next

Full log

View this message in rfc822 format

From: zimoun <zimon.toutoune <at> gmail.com>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: 43482 <at> debbugs.gnu.org
Subject: [bug#43482] [PATCH 3/3] doc: Reorder the "Channels" section.
Date: Thu, 24 Sep 2020 17:13:02 +0200

Hi,

Thank you for the review.

On Thu, 24 Sep 2020 at 16:59, Ludovic Courtès <ludo <at> gnu.org> wrote:

> > * 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.

I will try to do my best. :-)


> > +@node Writing custom channels
> > +@subsection Writing custom channels
>
> Should be “Writing Custom Channels”.
>
> Maybe “Creating a Channel” is more to the point actually?

Ok.


> > +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.

Ok.

> (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…)

Thanks for the explanations.


> Could you send updated patches?

Ok.


Cheers,
simon

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.