me/guix
Archived
1
0
Fork 0
Code Activity

doc: Update packaging guidelines.

Browse source 
* HACKING (Submitting Patches): Mention 'git send-mail'.
* doc/guix.texi (Packaging Guidelines): More details on how to prepare a
  package module.
  (Contributing): Add reference to #guix channel on Freenode.

Co-authored-by: Ludovic Courtès <ludo@gnu.org>
This commit is contained in:
Pierre-Antoine Rault 2014-03-09 17:10:27 +01:00 • committed by Ludovic Courtès
parent 8a1f6a7e02
commit 5ff3c4b820
2 changed files with 20 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
HACKING
View file

@ -2,8 +2,9 @@
#+TITLE: Hacking GNU Guix and Its Incredible Distro #+TITLE: Hacking GNU Guix and Its Incredible Distro
Copyright © 2012, 2013 Ludovic Courtès <ludo@gnu.org> Copyright © 2012, 2013, 2014 Ludovic Courtès <ludo@gnu.org>
Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org> Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org>
Copyright © 2014 Pierre-Antoine Rault <par@rigelk.eu>
Copying and distribution of this file, with or without modification, Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright are permitted in any medium without royalty provided the copyright
@ -85,7 +86,11 @@ wrapping it, swallowing or rejecting the following s-expression, etc.
Development is done using the Git distributed version control system. Thus, Development is done using the Git distributed version control system. Thus,
access to the repository is not strictly necessary. We welcome contributions access to the repository is not strictly necessary. We welcome contributions
in the form of patches as produced by ‘git format-patch’ sent to in the form of patches as produced by ‘git format-patch’ sent to
guix-devel@gnu.org. Please write commit logs in the [[http://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs][GNU ChangeLog format]]. guix-devel@gnu.org. Please write commit logs in the [[http://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs][GNU ChangeLog
format]]; you can check the commit history for examples.
When posting a patch to the mailing list, use "[PATCH] ..." as a subject. You
may use your email client or the ‘git send-mail’ command.
As you become a regular contributor, you may find it convenient to have write As you become a regular contributor, you may find it convenient to have write
access to the repository (see below.) access to the repository (see below.)

17
doc/guix.texi
View file

@ -2270,6 +2270,15 @@ called @code{gnew}, you may run this command from the Guix build tree:
Using @code{--keep-failed} makes it easier to debug build failures since Using @code{--keep-failed} makes it easier to debug build failures since
it provides access to the failed build tree. it provides access to the failed build tree.
If the package is unknown to the @command{guix} command, it may be that
the source file contains a syntax error, or lacks a @code{define-public}
clause to export the package variable. To figure it out, you may load
the module from Guile to get more information about the actual error:
@example
./pre-inst-env guile -c '(use-modules (gnu packages gnew))'
@end example
Once your package builds correctly, please send us a patch Once your package builds correctly, please send us a patch
(@pxref{Contributing}). Well, if you need help, we will be happy to (@pxref{Contributing}). Well, if you need help, we will be happy to
help you too. Once the patch is committed in the Guix repository, the help you too. Once the patch is committed in the Guix repository, the
@ -2784,10 +2793,10 @@ deco,,, dmd, GNU dmd Manual}).
@chapter Contributing @chapter Contributing
This project is a cooperative effort, and we need your help to make it This project is a cooperative effort, and we need your help to make it
grow! Please get in touch with us on @email{guix-devel@@gnu.org}. We grow! Please get in touch with us on @email{guix-devel@@gnu.org} and
welcome ideas, bug reports, patches, and anything that may be helpful to @code{#guix} on the Freenode IRC network. We welcome ideas, bug
the project. We particularly welcome help on packaging reports, patches, and anything that may be helpful to the project. We
(@pxref{Packaging Guidelines}). particularly welcome help on packaging (@pxref{Packaging Guidelines}).
Please see the Please see the
@url{http://git.savannah.gnu.org/cgit/guix.git/tree/HACKING, @url{http://git.savannah.gnu.org/cgit/guix.git/tree/HACKING,