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

doc: Clarify channel file structure.

Browse source 
Suggested by Hartmut Goebel <h.goebel@crazy-compilers.com>.

* doc/guix.texi (Channels): Clarify how a channel author should structure the
files in their channel's Git repository.
This commit is contained in:
Chris Marusich 2019-01-27 16:29:30 -08:00
parent cf0913f64e
commit b0a372637f
No known key found for this signature in database
GPG key ID: DD409A15D822469D
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/guix.texi
View file

@ -3705,9 +3705,8 @@ share your improvements, which are basic tenets of
email us at @email{guix-devel@@gnu.org} if you'd like to discuss this. email us at @email{guix-devel@@gnu.org} if you'd like to discuss this.
@end quotation @end quotation
Once you have a Git repository containing your own package modules, you can To use a channel, write @code{~/.config/guix/channels.scm} to instruct
write @code{~/.config/guix/channels.scm} to instruct @command{guix pull} to @command{guix pull} to pull from it @emph{in addition} to the default Guix
pull from your personal channel @emph{in addition} to the default Guix
channel(s): channel(s):
@vindex %default-channels @vindex %default-channels
@ -3751,6 +3750,17 @@ the new and upgraded packages that are listed, some like @code{my-gimp} and
@code{my-emacs-with-cool-features} might come from @code{my-emacs-with-cool-features} might come from
@code{my-personal-packages}, while others come from the Guix default channel. @code{my-personal-packages}, while others come from the Guix default channel.
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
start using a channel, Guix will behave as if the root directory of that
channel's Git repository has been added to the Guile load path (@pxref{Load
Paths,,, guile, GNU Guile Reference Manual}). For example, if your channel
contains a file at @file{my-packages/my-tools.scm} that defines a Guile
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}).
@cindex dependencies, channels @cindex dependencies, channels
@cindex meta-data, channels @cindex meta-data, channels
@subsection Declaring Channel Dependencies @subsection Declaring Channel Dependencies