diff options
| author | Pierre-Antoine Rault <par@rigelk.eu> | 2014-03-09 17:10:27 +0100 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2014-03-10 23:43:31 +0100 |
| commit | 5ff3c4b8207eb2fbbc48c9f429ccb65690def5ee (patch) | |
| tree | c7a540ad358d8efd0d56e859cbd8ec32bfbfff01 | |
| parent | 8a1f6a7e02afbe63dfa1193282c8b6807b845db2 (diff) | |
doc: Update packaging guidelines.
* 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>
| -rw-r--r-- | HACKING | 9 | ||||
| -rw-r--r-- | doc/guix.texi | 17 |
2 files changed, 20 insertions, 6 deletions
| @@ -2,8 +2,9 @@ | |||
| 2 | 2 | ||
| 3 | #+TITLE: Hacking GNU Guix and Its Incredible Distro | 3 | #+TITLE: Hacking GNU Guix and Its Incredible Distro |
| 4 | 4 | ||
| 5 | Copyright © 2012, 2013 Ludovic Courtès <ludo@gnu.org> | 5 | Copyright © 2012, 2013, 2014 Ludovic Courtès <ludo@gnu.org> |
| 6 | Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org> | 6 | Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org> |
| 7 | Copyright © 2014 Pierre-Antoine Rault <par@rigelk.eu> | ||
| 7 | 8 | ||
| 8 | Copying and distribution of this file, with or without modification, | 9 | Copying and distribution of this file, with or without modification, |
| 9 | are permitted in any medium without royalty provided the copyright | 10 | are permitted in any medium without royalty provided the copyright |
| @@ -85,7 +86,11 @@ wrapping it, swallowing or rejecting the following s-expression, etc. | |||
| 85 | Development is done using the Git distributed version control system. Thus, | 86 | Development is done using the Git distributed version control system. Thus, |
| 86 | access to the repository is not strictly necessary. We welcome contributions | 87 | access to the repository is not strictly necessary. We welcome contributions |
| 87 | in the form of patches as produced by ‘git format-patch’ sent to | 88 | in the form of patches as produced by ‘git format-patch’ sent to |
| 88 | 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]]. | 89 | 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 |
| 90 | format]]; you can check the commit history for examples. | ||
| 91 | |||
| 92 | When posting a patch to the mailing list, use "[PATCH] ..." as a subject. You | ||
| 93 | may use your email client or the ‘git send-mail’ command. | ||
| 89 | 94 | ||
| 90 | As you become a regular contributor, you may find it convenient to have write | 95 | As you become a regular contributor, you may find it convenient to have write |
| 91 | access to the repository (see below.) | 96 | access to the repository (see below.) |
diff --git a/doc/guix.texi b/doc/guix.texi index 150747f4450..701b5400f8e 100644 --- a/doc/guix.texi +++ b/doc/guix.texi | |||
| @@ -2270,6 +2270,15 @@ called @code{gnew}, you may run this command from the Guix build tree: | |||
| 2270 | Using @code{--keep-failed} makes it easier to debug build failures since | 2270 | Using @code{--keep-failed} makes it easier to debug build failures since |
| 2271 | it provides access to the failed build tree. | 2271 | it provides access to the failed build tree. |
| 2272 | 2272 | ||
| 2273 | If the package is unknown to the @command{guix} command, it may be that | ||
| 2274 | the source file contains a syntax error, or lacks a @code{define-public} | ||
| 2275 | clause to export the package variable. To figure it out, you may load | ||
| 2276 | the module from Guile to get more information about the actual error: | ||
| 2277 | |||
| 2278 | @example | ||
| 2279 | ./pre-inst-env guile -c '(use-modules (gnu packages gnew))' | ||
| 2280 | @end example | ||
| 2281 | |||
| 2273 | Once your package builds correctly, please send us a patch | 2282 | Once your package builds correctly, please send us a patch |
| 2274 | (@pxref{Contributing}). Well, if you need help, we will be happy to | 2283 | (@pxref{Contributing}). Well, if you need help, we will be happy to |
| 2275 | help you too. Once the patch is committed in the Guix repository, the | 2284 | help you too. Once the patch is committed in the Guix repository, the |
| @@ -2784,10 +2793,10 @@ deco,,, dmd, GNU dmd Manual}). | |||
| 2784 | @chapter Contributing | 2793 | @chapter Contributing |
| 2785 | 2794 | ||
| 2786 | This project is a cooperative effort, and we need your help to make it | 2795 | This project is a cooperative effort, and we need your help to make it |
| 2787 | grow! Please get in touch with us on @email{guix-devel@@gnu.org}. We | 2796 | grow! Please get in touch with us on @email{guix-devel@@gnu.org} and |
| 2788 | welcome ideas, bug reports, patches, and anything that may be helpful to | 2797 | @code{#guix} on the Freenode IRC network. We welcome ideas, bug |
| 2789 | the project. We particularly welcome help on packaging | 2798 | reports, patches, and anything that may be helpful to the project. We |
| 2790 | (@pxref{Packaging Guidelines}). | 2799 | particularly welcome help on packaging (@pxref{Packaging Guidelines}). |
| 2791 | 2800 | ||
| 2792 | Please see the | 2801 | Please see the |
| 2793 | @url{http://git.savannah.gnu.org/cgit/guix.git/tree/HACKING, | 2802 | @url{http://git.savannah.gnu.org/cgit/guix.git/tree/HACKING, |
