ryan77627/guix
1
0
Fork 0
mirror of https://git.in.rschanz.org/ryan77627/guix.git synced 2024-12-26 22:38:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Move "Primary URL" after "Specifying Channel Authorizations".

Browse source 
* doc/guix.texi (Primary URL): Move after "Specifying Channel
Authorizations" since the audience is channel authors who've already
taken care of authorizations.
This commit is contained in:
Ludovic Courtès 2020-09-27 22:39:49 +02:00
parent 12871cc8db
commit 3b7bd8cc90
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5
1 changed files with 25 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
doc/guix.texi
View file

@ -233,11 +233,11 @@ Channels
* Using a Custom Guix Channel:: Using a customized Guix. * Using a Custom Guix Channel:: Using a customized Guix.
* Replicating Guix:: Running the @emph{exact same} Guix. * Replicating Guix:: Running the @emph{exact same} Guix.
* Channel Authentication:: How Guix verifies what it fetches. * Channel Authentication:: How Guix verifies what it fetches.
* Primary URL:: Distinguishing mirror to original.
* Creating a Channel:: How to write your custom channel. * Creating a Channel:: How to write your custom channel.
* Package Modules in a Sub-directory:: Specifying the channel's package modules location. * Package Modules in a Sub-directory:: Specifying the channel's package modules location.
* Declaring Channel Dependencies:: How to depend on other channels. * Declaring Channel Dependencies:: How to depend on other channels.
* Specifying Channel Authorizations:: Defining channel authors authorizations. * Specifying Channel Authorizations:: Defining channel authors authorizations.
* Primary URL:: Distinguishing mirror to original.
* Writing Channel News:: Communicating information to channel's users. * Writing Channel News:: Communicating information to channel's users.
Development Development
@ -4691,11 +4691,11 @@ updates.
* Using a Custom Guix Channel:: Using a customized Guix. * Using a Custom Guix Channel:: Using a customized Guix.
* Replicating Guix:: Running the @emph{exact same} Guix. * Replicating Guix:: Running the @emph{exact same} Guix.
* Channel Authentication:: How Guix verifies what it fetches. * Channel Authentication:: How Guix verifies what it fetches.
* Primary URL:: Distinguishing mirror to original.
* Creating a Channel:: How to write your custom channel. * Creating a Channel:: How to write your custom channel.
* Package Modules in a Sub-directory:: Specifying the channel's package modules location. * Package Modules in a Sub-directory:: Specifying the channel's package modules location.
* Declaring Channel Dependencies:: How to depend on other channels. * Declaring Channel Dependencies:: How to depend on other channels.
* Specifying Channel Authorizations:: Defining channel authors authorizations. * Specifying Channel Authorizations:: Defining channel authors authorizations.
* Primary URL:: Distinguishing mirror to original.
* Writing Channel News:: Communicating information to channel's users. * Writing Channel News:: Communicating information to channel's users.
@end menu @end menu
@ -4852,29 +4852,6 @@ introduction from a trusted source since that is the root of your trust.
If you're curious about the authentication mechanics, read on! If you're curious about the authentication mechanics, read on!
@cindex primary URL, channels
@node Primary URL
@section Primary URL
Channel authors can indicate the primary URL of their channel's Git
repository in the @file{.guix-channel} file, like so:
@lisp
(channel
(version 0)
(url "https://example.org/guix.git"))
@end lisp
This allows @command{guix pull} to determine whether it is pulling code
from a mirror of the channel; when that is the case, it warns the user
that the mirror might be stale and displays the primary URL. That way,
users cannot be tricked into fetching code from a stale mirror that does
not receive security updates.
This feature only makes sense for authenticated repositories, such as
the official @code{guix} channel, for which @command{guix pull} ensures
the code it fetches is authentic.
@cindex personal packages (channels) @cindex personal packages (channels)
@cindex channels, for personal packages @cindex channels, for personal packages
@node Creating a Channel @node Creating a Channel
@ -5099,6 +5076,29 @@ authentication! Pay attention to merges in particular: merge commits
are considered authentic if and only if they are signed by a key present are considered authentic if and only if they are signed by a key present
in the @file{.guix-authorizations} file of @emph{both} branches. in the @file{.guix-authorizations} file of @emph{both} branches.
@cindex primary URL, channels
@node Primary URL
@section Primary URL
Channel authors can indicate the primary URL of their channel's Git
repository in the @file{.guix-channel} file, like so:
@lisp
(channel
(version 0)
(url "https://example.org/guix.git"))
@end lisp
This allows @command{guix pull} to determine whether it is pulling code
from a mirror of the channel; when that is the case, it warns the user
that the mirror might be stale and displays the primary URL. That way,
users cannot be tricked into fetching code from a stale mirror that does
not receive security updates.
This feature only makes sense for authenticated repositories, such as
the official @code{guix} channel, for which @command{guix pull} ensures
the code it fetches is authentic.
@cindex news, for channels @cindex news, for channels
@node Writing Channel News @node Writing Channel News
@section Writing Channel News @section Writing Channel News