Commit | Line | Data |
---|---|---|
8c01b9d0 ML |
1 | @node Contributing |
2 | @chapter Contributing | |
3 | ||
4 | This project is a cooperative effort, and we need your help to make it | |
5 | grow! Please get in touch with us on @email{guix-devel@@gnu.org} and | |
6 | @code{#guix} on the Freenode IRC network. We welcome ideas, bug | |
7 | reports, patches, and anything that may be helpful to the project. We | |
8 | particularly welcome help on packaging (@pxref{Packaging Guidelines}). | |
9 | ||
e15fcdd1 LC |
10 | @cindex code of conduct, of contributors |
11 | @cindex contributor covenant | |
dcb7119a AS |
12 | We want to provide a warm, friendly, and harassment-free environment, so |
13 | that anyone can contribute to the best of their abilities. To this end | |
14 | our project uses a ``Contributor Covenant'', which was adapted from | |
478af028 | 15 | @url{https://contributor-covenant.org/}. You can find a local version in |
dcb7119a | 16 | the @file{CODE-OF-CONDUCT} file in the source tree. |
e15fcdd1 | 17 | |
dfcdd9c2 LC |
18 | Contributors are not required to use their legal name in patches and |
19 | on-line communication; they can use any name or pseudonym of their | |
20 | choice. | |
21 | ||
8c01b9d0 ML |
22 | @menu |
23 | * Building from Git:: The latest and greatest. | |
24 | * Running Guix Before It Is Installed:: Hacker tricks. | |
25 | * The Perfect Setup:: The right tools. | |
afe7408e | 26 | * Packaging Guidelines:: Growing the distribution. |
8c01b9d0 ML |
27 | * Coding Style:: Hygiene of the contributor. |
28 | * Submitting Patches:: Share your work. | |
a7bde77d | 29 | * Tracking Bugs and Patches:: Using Debbugs. |
2d315cd4 | 30 | * Commit Access:: Pushing to the official repository. |
8c01b9d0 ML |
31 | @end menu |
32 | ||
33 | @node Building from Git | |
34 | @section Building from Git | |
35 | ||
36 | If you want to hack Guix itself, it is recommended to use the latest | |
dbfcadfc LC |
37 | version from the Git repository: |
38 | ||
39 | @example | |
40 | git clone https://git.savannah.gnu.org/git/guix.git | |
41 | @end example | |
42 | ||
b3011dbb LC |
43 | @cindex authentication, of a Guix checkout |
44 | How do you ensure that you obtained a genuine copy of the repository? | |
45 | Guix itself provides a tool to @dfn{authenticate} your checkout, but you | |
46 | must first make sure this tool is genuine in order to ``bootstrap'' the | |
47 | trust chain. To do that, run: | |
48 | ||
49 | @c XXX: Adjust instructions when there's a known tag to start from. | |
50 | @example | |
51 | git verify-commit `git log --format=%H build-aux/git-authenticate.scm` | |
52 | @end example | |
53 | ||
54 | The output must look something like: | |
55 | ||
56 | @example | |
57 | gpg: Signature made Fri 27 Dec 2019 01:27:41 PM CET | |
58 | gpg: using RSA key 3CE464558A84FDC69DB40CFB090B11993D9AEBB5 | |
59 | @dots{} | |
60 | gpg: Signature made Fri 27 Dec 2019 01:25:22 PM CET | |
61 | gpg: using RSA key 3CE464558A84FDC69DB40CFB090B11993D9AEBB5 | |
62 | @dots{} | |
63 | @end example | |
64 | ||
65 | @noindent | |
66 | ... meaning that changes to this file are all signed with key | |
67 | @code{3CE464558A84FDC69DB40CFB090B11993D9AEBB5} (you may need to fetch | |
68 | this key from a key server, if you have not done it yet). | |
69 | ||
70 | From there on, you can authenticate all the commits included in your | |
71 | checkout by running: | |
72 | ||
73 | @example | |
74 | make authenticate | |
75 | @end example | |
76 | ||
77 | The first run takes a couple of minutes, but subsequent runs are faster. | |
78 | ||
79 | @quotation Note | |
80 | You are advised to run @command{make authenticate} after every | |
81 | @command{git pull} invocation. This ensures you keep receiving valid | |
82 | changes to the repository | |
83 | @end quotation | |
84 | ||
5fb95cc5 LC |
85 | The easiest way to set up a development environment for Guix is, of |
86 | course, by using Guix! The following command starts a new shell where | |
87 | all the dependencies and appropriate environment variables are set up to | |
88 | hack on Guix: | |
8c01b9d0 | 89 | |
5fb95cc5 | 90 | @example |
43ec98ef | 91 | guix environment guix --pure |
5fb95cc5 LC |
92 | @end example |
93 | ||
94 | @xref{Invoking guix environment}, for more information on that command. | |
0636742b FP |
95 | |
96 | If you are unable to use Guix when building Guix from a checkout, the | |
97 | following are the required packages in addition to those mentioned in the | |
98 | installation instructions (@pxref{Requirements}). | |
99 | ||
100 | @itemize | |
21656ffa VS |
101 | @item @url{https://gnu.org/software/autoconf/, GNU Autoconf}; |
102 | @item @url{https://gnu.org/software/automake/, GNU Automake}; | |
103 | @item @url{https://gnu.org/software/gettext/, GNU Gettext}; | |
104 | @item @url{https://gnu.org/software/texinfo/, GNU Texinfo}; | |
105 | @item @url{https://www.graphviz.org/, Graphviz}; | |
106 | @item @url{https://www.gnu.org/software/help2man/, GNU Help2man (optional)}. | |
0636742b FP |
107 | @end itemize |
108 | ||
109 | On Guix, extra dependencies can be added by instead running @command{guix | |
110 | environment} with @option{--ad-hoc}: | |
5fb95cc5 LC |
111 | |
112 | @example | |
43ec98ef | 113 | guix environment guix --pure --ad-hoc help2man git strace |
5fb95cc5 LC |
114 | @end example |
115 | ||
116 | Run @command{./bootstrap} to generate the build system infrastructure | |
117 | using Autoconf and Automake. If you get an error like this one: | |
8c01b9d0 ML |
118 | |
119 | @example | |
120 | configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES | |
121 | @end example | |
122 | ||
5fb95cc5 | 123 | @noindent |
8c01b9d0 | 124 | it probably means that Autoconf couldn’t find @file{pkg.m4}, which is |
5fb95cc5 LC |
125 | provided by pkg-config. Make sure that @file{pkg.m4} is available. The |
126 | same holds for the @file{guile.m4} set of macros provided by Guile. For | |
127 | instance, if you installed Automake in @file{/usr/local}, it wouldn’t | |
128 | look for @file{.m4} files in @file{/usr/share}. In that case, you have | |
129 | to invoke the following command: | |
8c01b9d0 ML |
130 | |
131 | @example | |
132 | export ACLOCAL_PATH=/usr/share/aclocal | |
133 | @end example | |
134 | ||
aabe6d38 | 135 | @xref{Macro Search Path,,, automake, The GNU Automake Manual}, for |
8c01b9d0 ML |
136 | more information. |
137 | ||
3a25c631 LC |
138 | Then, run @command{./configure} as usual. Make sure to pass |
139 | @code{--localstatedir=@var{directory}} where @var{directory} is the | |
140 | @code{localstatedir} value used by your current installation (@pxref{The | |
0758a70c | 141 | Store}, for information about this). We recommend to use the value |
142 | @code{/var}. | |
8c01b9d0 | 143 | |
3a25c631 LC |
144 | Finally, you have to invoke @code{make check} to run tests |
145 | (@pxref{Running the Test Suite}). If anything | |
8c01b9d0 ML |
146 | fails, take a look at installation instructions (@pxref{Installation}) |
147 | or send a message to the @email{guix-devel@@gnu.org, mailing list}. | |
148 | ||
149 | ||
150 | @node Running Guix Before It Is Installed | |
151 | @section Running Guix Before It Is Installed | |
152 | ||
153 | In order to keep a sane working environment, you will find it useful to | |
154 | test the changes made in your local source tree checkout without | |
155 | actually installing them. So that you can distinguish between your | |
156 | ``end-user'' hat and your ``motley'' costume. | |
157 | ||
158 | To that end, all the command-line tools can be used even if you have not | |
0207768f LC |
159 | run @code{make install}. To do that, you first need to have an environment |
160 | with all the dependencies available (@pxref{Building from Git}), and then | |
161 | simply prefix each command with | |
8c01b9d0 | 162 | @command{./pre-inst-env} (the @file{pre-inst-env} script lives in the |
0636742b FP |
163 | top build tree of Guix; it is generated by @command{./configure}). |
164 | An example@footnote{The @option{-E} flag to | |
67441b9a LC |
165 | @command{sudo} guarantees that @code{GUILE_LOAD_PATH} is correctly set |
166 | such that @command{guix-daemon} and the tools it uses can find the Guile | |
167 | modules they need.}: | |
8c01b9d0 ML |
168 | |
169 | @example | |
67441b9a | 170 | $ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild |
8c01b9d0 ML |
171 | $ ./pre-inst-env guix build hello |
172 | @end example | |
173 | ||
174 | @noindent | |
0636742b | 175 | Similarly, an example for a Guile session using the Guix modules: |
8c01b9d0 ML |
176 | |
177 | @example | |
178 | $ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))' | |
96856613 LC |
179 | |
180 | ;;; ("x86_64-linux") | |
181 | @end example | |
182 | ||
183 | @noindent | |
184 | @cindex REPL | |
185 | @cindex read-eval-print loop | |
186 | @dots{} and for a REPL (@pxref{Using Guile Interactively,,, guile, Guile | |
187 | Reference Manual}): | |
188 | ||
189 | @example | |
190 | $ ./pre-inst-env guile | |
191 | scheme@@(guile-user)> ,use(guix) | |
192 | scheme@@(guile-user)> ,use(gnu) | |
193 | scheme@@(guile-user)> (define snakes | |
194 | (fold-packages | |
195 | (lambda (package lst) | |
196 | (if (string-prefix? "python" | |
197 | (package-name package)) | |
198 | (cons package lst) | |
199 | lst)) | |
200 | '())) | |
201 | scheme@@(guile-user)> (length snakes) | |
202 | $1 = 361 | |
8c01b9d0 ML |
203 | @end example |
204 | ||
205 | The @command{pre-inst-env} script sets up all the environment variables | |
206 | necessary to support this, including @env{PATH} and @env{GUILE_LOAD_PATH}. | |
207 | ||
ef54b61d | 208 | Note that @command{./pre-inst-env guix pull} does @emph{not} upgrade the |
75e24d7b | 209 | local source tree; it simply updates the @file{~/.config/guix/current} |
ef54b61d | 210 | symlink (@pxref{Invoking guix pull}). Run @command{git pull} instead if |
75e24d7b | 211 | you want to upgrade your local source tree. |
ef54b61d | 212 | |
8c01b9d0 ML |
213 | |
214 | @node The Perfect Setup | |
215 | @section The Perfect Setup | |
216 | ||
217 | The Perfect Setup to hack on Guix is basically the perfect setup used | |
218 | for Guile hacking (@pxref{Using Guile in Emacs,,, guile, Guile Reference | |
219 | Manual}). First, you need more than an editor, you need | |
21656ffa VS |
220 | @url{https://www.gnu.org/software/emacs, Emacs}, empowered by the |
221 | wonderful @url{https://nongnu.org/geiser/, Geiser}. To set that up, run: | |
f73ab814 LC |
222 | |
223 | @example | |
224 | guix package -i emacs guile emacs-geiser | |
225 | @end example | |
8c01b9d0 ML |
226 | |
227 | Geiser allows for interactive and incremental development from within | |
228 | Emacs: code compilation and evaluation from within buffers, access to | |
229 | on-line documentation (docstrings), context-sensitive completion, | |
230 | @kbd{M-.} to jump to an object definition, a REPL to try out your code, | |
231 | and more (@pxref{Introduction,,, geiser, Geiser User Manual}). For | |
232 | convenient Guix development, make sure to augment Guile’s load path so | |
233 | that it finds source files from your checkout: | |
234 | ||
235 | @lisp | |
236 | ;; @r{Assuming the Guix checkout is in ~/src/guix.} | |
bb38ece4 AK |
237 | (with-eval-after-load 'geiser-guile |
238 | (add-to-list 'geiser-guile-load-path "~/src/guix")) | |
8c01b9d0 ML |
239 | @end lisp |
240 | ||
241 | To actually edit the code, Emacs already has a neat Scheme mode. But in | |
242 | addition to that, you must not miss | |
c2c73f58 | 243 | @url{https://www.emacswiki.org/emacs/ParEdit, Paredit}. It provides |
8c01b9d0 ML |
244 | facilities to directly operate on the syntax tree, such as raising an |
245 | s-expression or wrapping it, swallowing or rejecting the following | |
246 | s-expression, etc. | |
247 | ||
42cdcdff RW |
248 | @cindex code snippets |
249 | @cindex templates | |
250 | @cindex reducing boilerplate | |
251 | We also provide templates for common git commit messages and package | |
252 | definitions in the @file{etc/snippets} directory. These templates can | |
21656ffa | 253 | be used with @url{https://joaotavora.github.io/yasnippet/, YASnippet} to |
42cdcdff RW |
254 | expand short trigger strings to interactive text snippets. You may want |
255 | to add the snippets directory to the @var{yas-snippet-dirs} variable in | |
256 | Emacs. | |
257 | ||
258 | @lisp | |
259 | ;; @r{Assuming the Guix checkout is in ~/src/guix.} | |
260 | (with-eval-after-load 'yasnippet | |
261 | (add-to-list 'yas-snippet-dirs "~/src/guix/etc/snippets")) | |
262 | @end lisp | |
263 | ||
264 | The commit message snippets depend on @url{https://magit.vc/, Magit} to | |
265 | display staged files. When editing a commit message type @code{add} | |
266 | followed by @kbd{TAB} to insert a commit message template for adding a | |
267 | package; type @code{update} followed by @kbd{TAB} to insert a template | |
9286c295 AI |
268 | for updating a package; type @code{https} followed by @kbd{TAB} to |
269 | insert a template for changing the home page URI of a package to HTTPS. | |
42cdcdff RW |
270 | |
271 | The main snippet for @code{scheme-mode} is triggered by typing | |
272 | @code{package...} followed by @kbd{TAB}. This snippet also inserts the | |
273 | trigger string @code{origin...}, which can be expanded further. The | |
274 | @code{origin} snippet in turn may insert other trigger strings ending on | |
275 | @code{...}, which also can be expanded further. | |
276 | ||
9a397114 OP |
277 | @cindex insert or update copyright |
278 | @cindex @code{M-x guix-copyright} | |
279 | @cindex @code{M-x copyright-update} | |
280 | Additionaly we provide insertion and automatic update of a copyright in | |
281 | @file{etc/copyright.el}. You may want to set your full name, mail, and | |
282 | load a file. | |
283 | ||
284 | @lisp | |
285 | (setq user-full-name "Alice Doe") | |
286 | (setq user-mail-address "alice@@mail.org") | |
287 | ;; @r{Assuming the Guix checkout is in ~/src/guix.} | |
288 | (load-file "~/src/guix/etc/copyright.el") | |
289 | @end lisp | |
290 | ||
291 | To insert a copyright at the current line invoke @code{M-x guix-copyright}. | |
292 | ||
293 | To update a copyright you need to specify a @code{copyright-names-regexp}. | |
294 | ||
295 | @lisp | |
296 | (setq copyright-names-regexp | |
297 | (format "%s <%s>" user-full-name user-mail-address)) | |
298 | @end lisp | |
299 | ||
300 | You can check if your copyright is up to date by evaluating @code{M-x | |
301 | copyright-update}. If you want to do it automatically after each buffer | |
302 | save then add @code{(add-hook 'after-save-hook 'copyright-update)} in | |
303 | Emacs. | |
8c01b9d0 | 304 | |
afe7408e LC |
305 | @node Packaging Guidelines |
306 | @section Packaging Guidelines | |
307 | ||
308 | @cindex packages, creating | |
309 | The GNU distribution is nascent and may well lack some of your favorite | |
310 | packages. This section describes how you can help make the distribution | |
311 | grow. | |
312 | ||
313 | Free software packages are usually distributed in the form of | |
314 | @dfn{source code tarballs}---typically @file{tar.gz} files that contain | |
315 | all the source files. Adding a package to the distribution means | |
316 | essentially two things: adding a @dfn{recipe} that describes how to | |
317 | build the package, including a list of other packages required to build | |
318 | it, and adding @dfn{package metadata} along with that recipe, such as a | |
319 | description and licensing information. | |
320 | ||
321 | In Guix all this information is embodied in @dfn{package definitions}. | |
322 | Package definitions provide a high-level view of the package. They are | |
323 | written using the syntax of the Scheme programming language; in fact, | |
324 | for each package we define a variable bound to the package definition, | |
325 | and export that variable from a module (@pxref{Package Modules}). | |
326 | However, in-depth Scheme knowledge is @emph{not} a prerequisite for | |
327 | creating packages. For more information on package definitions, | |
328 | @pxref{Defining Packages}. | |
329 | ||
330 | Once a package definition is in place, stored in a file in the Guix | |
331 | source tree, it can be tested using the @command{guix build} command | |
332 | (@pxref{Invoking guix build}). For example, assuming the new package is | |
333 | called @code{gnew}, you may run this command from the Guix build tree | |
334 | (@pxref{Running Guix Before It Is Installed}): | |
335 | ||
336 | @example | |
337 | ./pre-inst-env guix build gnew --keep-failed | |
338 | @end example | |
339 | ||
340 | Using @code{--keep-failed} makes it easier to debug build failures since | |
341 | it provides access to the failed build tree. Another useful | |
342 | command-line option when debugging is @code{--log-file}, to access the | |
343 | build log. | |
344 | ||
345 | If the package is unknown to the @command{guix} command, it may be that | |
346 | the source file contains a syntax error, or lacks a @code{define-public} | |
347 | clause to export the package variable. To figure it out, you may load | |
348 | the module from Guile to get more information about the actual error: | |
349 | ||
350 | @example | |
351 | ./pre-inst-env guile -c '(use-modules (gnu packages gnew))' | |
352 | @end example | |
353 | ||
354 | Once your package builds correctly, please send us a patch | |
355 | (@pxref{Submitting Patches}). Well, if you need help, we will be happy to | |
356 | help you too. Once the patch is committed in the Guix repository, the | |
357 | new package automatically gets built on the supported platforms by | |
44b5f28a | 358 | @url{@value{SUBSTITUTE-SERVER}, our continuous integration system}. |
afe7408e LC |
359 | |
360 | @cindex substituter | |
361 | Users can obtain the new package definition simply by running | |
362 | @command{guix pull} (@pxref{Invoking guix pull}). When | |
363 | @code{@value{SUBSTITUTE-SERVER}} is done building the package, installing the | |
364 | package automatically downloads binaries from there | |
365 | (@pxref{Substitutes}). The only place where human intervention is | |
366 | needed is to review and apply the patch. | |
367 | ||
368 | ||
369 | @menu | |
370 | * Software Freedom:: What may go into the distribution. | |
371 | * Package Naming:: What's in a name? | |
372 | * Version Numbers:: When the name is not enough. | |
373 | * Synopses and Descriptions:: Helping users find the right package. | |
374 | * Python Modules:: A touch of British comedy. | |
375 | * Perl Modules:: Little pearls. | |
376 | * Java Packages:: Coffee break. | |
8d1b22b2 | 377 | * Rust Crates:: Beware of oxidation. |
afe7408e LC |
378 | * Fonts:: Fond of fonts. |
379 | @end menu | |
380 | ||
381 | @node Software Freedom | |
382 | @subsection Software Freedom | |
383 | ||
384 | @c Adapted from http://www.gnu.org/philosophy/philosophy.html. | |
385 | @cindex free software | |
386 | The GNU operating system has been developed so that users can have | |
387 | freedom in their computing. GNU is @dfn{free software}, meaning that | |
21656ffa | 388 | users have the @url{https://www.gnu.org/philosophy/free-sw.html,four |
afe7408e LC |
389 | essential freedoms}: to run the program, to study and change the program |
390 | in source code form, to redistribute exact copies, and to distribute | |
391 | modified versions. Packages found in the GNU distribution provide only | |
392 | software that conveys these four freedoms. | |
393 | ||
394 | In addition, the GNU distribution follow the | |
21656ffa | 395 | @url{https://www.gnu.org/distros/free-system-distribution-guidelines.html,free |
afe7408e LC |
396 | software distribution guidelines}. Among other things, these guidelines |
397 | reject non-free firmware, recommendations of non-free software, and | |
398 | discuss ways to deal with trademarks and patents. | |
399 | ||
400 | Some otherwise free upstream package sources contain a small and optional | |
401 | subset that violates the above guidelines, for instance because this subset | |
402 | is itself non-free code. When that happens, the offending items are removed | |
403 | with appropriate patches or code snippets in the @code{origin} form of the | |
404 | package (@pxref{Defining Packages}). This way, @code{guix | |
405 | build --source} returns the ``freed'' source rather than the unmodified | |
406 | upstream source. | |
407 | ||
408 | ||
409 | @node Package Naming | |
410 | @subsection Package Naming | |
411 | ||
412 | @cindex package name | |
413 | A package has actually two names associated with it: | |
414 | First, there is the name of the @emph{Scheme variable}, the one following | |
415 | @code{define-public}. By this name, the package can be made known in the | |
416 | Scheme code, for instance as input to another package. Second, there is | |
417 | the string in the @code{name} field of a package definition. This name | |
418 | is used by package management commands such as | |
419 | @command{guix package} and @command{guix build}. | |
420 | ||
421 | Both are usually the same and correspond to the lowercase conversion of | |
422 | the project name chosen upstream, with underscores replaced with | |
423 | hyphens. For instance, GNUnet is available as @code{gnunet}, and | |
424 | SDL_net as @code{sdl-net}. | |
425 | ||
426 | We do not add @code{lib} prefixes for library packages, unless these are | |
427 | already part of the official project name. But @pxref{Python | |
428 | Modules} and @ref{Perl Modules} for special rules concerning modules for | |
429 | the Python and Perl languages. | |
430 | ||
431 | Font package names are handled differently, @pxref{Fonts}. | |
432 | ||
433 | ||
434 | @node Version Numbers | |
435 | @subsection Version Numbers | |
436 | ||
437 | @cindex package version | |
438 | We usually package only the latest version of a given free software | |
439 | project. But sometimes, for instance for incompatible library versions, | |
440 | two (or more) versions of the same package are needed. These require | |
441 | different Scheme variable names. We use the name as defined | |
442 | in @ref{Package Naming} | |
443 | for the most recent version; previous versions use the same name, suffixed | |
444 | by @code{-} and the smallest prefix of the version number that may | |
445 | distinguish the two versions. | |
446 | ||
447 | The name inside the package definition is the same for all versions of a | |
448 | package and does not contain any version number. | |
449 | ||
450 | For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as follows: | |
451 | ||
8ba31e8b | 452 | @lisp |
afe7408e LC |
453 | (define-public gtk+ |
454 | (package | |
455 | (name "gtk+") | |
456 | (version "3.9.12") | |
457 | ...)) | |
458 | (define-public gtk+-2 | |
459 | (package | |
460 | (name "gtk+") | |
461 | (version "2.24.20") | |
462 | ...)) | |
8ba31e8b | 463 | @end lisp |
afe7408e | 464 | If we also wanted GTK+ 3.8.2, this would be packaged as |
8ba31e8b | 465 | @lisp |
afe7408e LC |
466 | (define-public gtk+-3.8 |
467 | (package | |
468 | (name "gtk+") | |
469 | (version "3.8.2") | |
470 | ...)) | |
8ba31e8b | 471 | @end lisp |
afe7408e LC |
472 | |
473 | @c See <https://lists.gnu.org/archive/html/guix-devel/2016-01/msg00425.html>, | |
474 | @c for a discussion of what follows. | |
475 | @cindex version number, for VCS snapshots | |
476 | Occasionally, we package snapshots of upstream's version control system | |
477 | (VCS) instead of formal releases. This should remain exceptional, | |
478 | because it is up to upstream developers to clarify what the stable | |
479 | release is. Yet, it is sometimes necessary. So, what should we put in | |
480 | the @code{version} field? | |
481 | ||
482 | Clearly, we need to make the commit identifier of the VCS snapshot | |
483 | visible in the version string, but we also need to make sure that the | |
484 | version string is monotonically increasing so that @command{guix package | |
485 | --upgrade} can determine which version is newer. Since commit | |
486 | identifiers, notably with Git, are not monotonically increasing, we add | |
487 | a revision number that we increase each time we upgrade to a newer | |
488 | snapshot. The resulting version string looks like this: | |
489 | ||
490 | @example | |
491 | 2.0.11-3.cabba9e | |
492 | ^ ^ ^ | |
493 | | | `-- upstream commit ID | |
494 | | | | |
495 | | `--- Guix package revision | |
496 | | | |
497 | latest upstream version | |
498 | @end example | |
499 | ||
500 | It is a good idea to strip commit identifiers in the @code{version} | |
501 | field to, say, 7 digits. It avoids an aesthetic annoyance (assuming | |
502 | aesthetics have a role to play here) as well as problems related to OS | |
503 | limits such as the maximum shebang length (127 bytes for the Linux | |
504 | kernel.) It is best to use the full commit identifiers in | |
505 | @code{origin}s, though, to avoid ambiguities. A typical package | |
506 | definition may look like this: | |
507 | ||
8ba31e8b | 508 | @lisp |
afe7408e LC |
509 | (define my-package |
510 | (let ((commit "c3f29bc928d5900971f65965feaae59e1272a3f7") | |
511 | (revision "1")) ;Guix package revision | |
512 | (package | |
513 | (version (git-version "0.9" revision commit)) | |
514 | (source (origin | |
515 | (method git-fetch) | |
516 | (uri (git-reference | |
517 | (url "git://example.org/my-package.git") | |
518 | (commit commit))) | |
519 | (sha256 (base32 "1mbikn@dots{}")) | |
520 | (file-name (git-file-name name version)))) | |
521 | ;; @dots{} | |
522 | ))) | |
8ba31e8b | 523 | @end lisp |
afe7408e LC |
524 | |
525 | @node Synopses and Descriptions | |
526 | @subsection Synopses and Descriptions | |
527 | ||
528 | @cindex package description | |
529 | @cindex package synopsis | |
530 | As we have seen before, each package in GNU@tie{}Guix includes a | |
531 | synopsis and a description (@pxref{Defining Packages}). Synopses and | |
532 | descriptions are important: They are what @command{guix package | |
533 | --search} searches, and a crucial piece of information to help users | |
534 | determine whether a given package suits their needs. Consequently, | |
535 | packagers should pay attention to what goes into them. | |
536 | ||
537 | Synopses must start with a capital letter and must not end with a | |
538 | period. They must not start with ``a'' or ``the'', which usually does | |
539 | not bring anything; for instance, prefer ``File-frobbing tool'' over ``A | |
540 | tool that frobs files''. The synopsis should say what the package | |
541 | is---e.g., ``Core GNU utilities (file, text, shell)''---or what it is | |
542 | used for---e.g., the synopsis for GNU@tie{}grep is ``Print lines | |
543 | matching a pattern''. | |
544 | ||
545 | Keep in mind that the synopsis must be meaningful for a very wide | |
546 | audience. For example, ``Manipulate alignments in the SAM format'' | |
547 | might make sense for a seasoned bioinformatics researcher, but might be | |
548 | fairly unhelpful or even misleading to a non-specialized audience. It | |
549 | is a good idea to come up with a synopsis that gives an idea of the | |
550 | application domain of the package. In this example, this might give | |
551 | something like ``Manipulate nucleotide sequence alignments'', which | |
552 | hopefully gives the user a better idea of whether this is what they are | |
553 | looking for. | |
554 | ||
555 | Descriptions should take between five and ten lines. Use full | |
556 | sentences, and avoid using acronyms without first introducing them. | |
557 | Please avoid marketing phrases such as ``world-leading'', | |
558 | ``industrial-strength'', and ``next-generation'', and avoid superlatives | |
559 | like ``the most advanced''---they are not helpful to users looking for a | |
560 | package and may even sound suspicious. Instead, try to be factual, | |
561 | mentioning use cases and features. | |
562 | ||
563 | @cindex Texinfo markup, in package descriptions | |
564 | Descriptions can include Texinfo markup, which is useful to introduce | |
565 | ornaments such as @code{@@code} or @code{@@dfn}, bullet lists, or | |
566 | hyperlinks (@pxref{Overview,,, texinfo, GNU Texinfo}). However you | |
567 | should be careful when using some characters for example @samp{@@} and | |
568 | curly braces which are the basic special characters in Texinfo | |
569 | (@pxref{Special Characters,,, texinfo, GNU Texinfo}). User interfaces | |
570 | such as @command{guix package --show} take care of rendering it | |
571 | appropriately. | |
572 | ||
573 | Synopses and descriptions are translated by volunteers | |
21656ffa | 574 | @uref{https://translationproject.org/domain/guix-packages.html, at the |
afe7408e LC |
575 | Translation Project} so that as many users as possible can read them in |
576 | their native language. User interfaces search them and display them in | |
577 | the language specified by the current locale. | |
578 | ||
579 | To allow @command{xgettext} to extract them as translatable strings, | |
580 | synopses and descriptions @emph{must be literal strings}. This means | |
581 | that you cannot use @code{string-append} or @code{format} to construct | |
582 | these strings: | |
583 | ||
584 | @lisp | |
585 | (package | |
586 | ;; @dots{} | |
587 | (synopsis "This is translatable") | |
588 | (description (string-append "This is " "*not*" " translatable."))) | |
589 | @end lisp | |
590 | ||
591 | Translation is a lot of work so, as a packager, please pay even more | |
592 | attention to your synopses and descriptions as every change may entail | |
593 | additional work for translators. In order to help them, it is possible | |
594 | to make recommendations or instructions visible to them by inserting | |
595 | special comments like this (@pxref{xgettext Invocation,,, gettext, GNU | |
596 | Gettext}): | |
597 | ||
598 | @example | |
599 | ;; TRANSLATORS: "X11 resize-and-rotate" should not be translated. | |
600 | (description "ARandR is designed to provide a simple visual front end | |
601 | for the X11 resize-and-rotate (RandR) extension. @dots{}") | |
602 | @end example | |
603 | ||
604 | ||
605 | @node Python Modules | |
606 | @subsection Python Modules | |
607 | ||
608 | @cindex python | |
609 | We currently package Python 2 and Python 3, under the Scheme variable names | |
610 | @code{python-2} and @code{python} as explained in @ref{Version Numbers}. | |
611 | To avoid confusion and naming clashes with other programming languages, it | |
612 | seems desirable that the name of a package for a Python module contains | |
613 | the word @code{python}. | |
614 | ||
39356057 LF |
615 | Some modules are compatible with only one version of Python, others with |
616 | both. If the package Foo is compiled with Python 3, we name it | |
617 | @code{python-foo}. If it is compiled with Python 2, we name it | |
618 | @code{python2-foo}. Packages should be added when they are necessary; | |
619 | we don't add Python 2 variants of the package unless we are going to use | |
620 | them. | |
afe7408e LC |
621 | |
622 | If a project already contains the word @code{python}, we drop this; | |
623 | for instance, the module python-dateutil is packaged under the names | |
624 | @code{python-dateutil} and @code{python2-dateutil}. If the project name | |
625 | starts with @code{py} (e.g.@: @code{pytz}), we keep it and prefix it as | |
626 | described above. | |
627 | ||
628 | @subsubsection Specifying Dependencies | |
629 | @cindex inputs, for Python packages | |
630 | ||
631 | Dependency information for Python packages is usually available in the | |
632 | package source tree, with varying degrees of accuracy: in the | |
633 | @file{setup.py} file, in @file{requirements.txt}, or in @file{tox.ini}. | |
634 | ||
635 | Your mission, when writing a recipe for a Python package, is to map | |
636 | these dependencies to the appropriate type of ``input'' (@pxref{package | |
637 | Reference, inputs}). Although the @code{pypi} importer normally does a | |
638 | good job (@pxref{Invoking guix import}), you may want to check the | |
639 | following check list to determine which dependency goes where. | |
640 | ||
641 | @itemize | |
642 | ||
643 | @item | |
644 | We currently package Python 2 with @code{setuptools} and @code{pip} | |
645 | installed like Python 3.4 has per default. Thus you don't need to | |
646 | specify either of these as an input. @command{guix lint} will warn you | |
647 | if you do. | |
648 | ||
649 | @item | |
650 | Python dependencies required at run time go into | |
651 | @code{propagated-inputs}. They are typically defined with the | |
652 | @code{install_requires} keyword in @file{setup.py}, or in the | |
653 | @file{requirements.txt} file. | |
654 | ||
655 | @item | |
656 | Python packages required only at build time---e.g., those listed with | |
657 | the @code{setup_requires} keyword in @file{setup.py}---or only for | |
658 | testing---e.g., those in @code{tests_require}---go into | |
659 | @code{native-inputs}. The rationale is that (1) they do not need to be | |
660 | propagated because they are not needed at run time, and (2) in a | |
661 | cross-compilation context, it's the ``native'' input that we'd want. | |
662 | ||
663 | Examples are the @code{pytest}, @code{mock}, and @code{nose} test | |
664 | frameworks. Of course if any of these packages is also required at | |
665 | run-time, it needs to go to @code{propagated-inputs}. | |
666 | ||
667 | @item | |
668 | Anything that does not fall in the previous categories goes to | |
669 | @code{inputs}, for example programs or C libraries required for building | |
670 | Python packages containing C extensions. | |
671 | ||
672 | @item | |
673 | If a Python package has optional dependencies (@code{extras_require}), | |
674 | it is up to you to decide whether to add them or not, based on their | |
675 | usefulness/overhead ratio (@pxref{Submitting Patches, @command{guix | |
676 | size}}). | |
677 | ||
678 | @end itemize | |
679 | ||
680 | ||
681 | @node Perl Modules | |
682 | @subsection Perl Modules | |
683 | ||
684 | @cindex perl | |
685 | Perl programs standing for themselves are named as any other package, | |
686 | using the lowercase upstream name. | |
687 | For Perl packages containing a single class, we use the lowercase class name, | |
688 | replace all occurrences of @code{::} by dashes and prepend the prefix | |
689 | @code{perl-}. | |
690 | So the class @code{XML::Parser} becomes @code{perl-xml-parser}. | |
691 | Modules containing several classes keep their lowercase upstream name and | |
692 | are also prepended by @code{perl-}. Such modules tend to have the word | |
693 | @code{perl} somewhere in their name, which gets dropped in favor of the | |
694 | prefix. For instance, @code{libwww-perl} becomes @code{perl-libwww}. | |
695 | ||
696 | ||
697 | @node Java Packages | |
698 | @subsection Java Packages | |
699 | ||
700 | @cindex java | |
701 | Java programs standing for themselves are named as any other package, | |
702 | using the lowercase upstream name. | |
703 | ||
704 | To avoid confusion and naming clashes with other programming languages, | |
705 | it is desirable that the name of a package for a Java package is | |
706 | prefixed with @code{java-}. If a project already contains the word | |
707 | @code{java}, we drop this; for instance, the package @code{ngsjava} is | |
708 | packaged under the name @code{java-ngs}. | |
709 | ||
710 | For Java packages containing a single class or a small class hierarchy, | |
711 | we use the lowercase class name, replace all occurrences of @code{.} by | |
712 | dashes and prepend the prefix @code{java-}. So the class | |
713 | @code{apache.commons.cli} becomes package | |
714 | @code{java-apache-commons-cli}. | |
715 | ||
716 | ||
8d1b22b2 EF |
717 | @node Rust Crates |
718 | @subsection Rust Crates | |
719 | ||
720 | @cindex rust | |
721 | Rust programs standing for themselves are named as any other package, using the | |
722 | lowercase upstream name. | |
723 | ||
724 | To prevent namespace collisions we prefix all other Rust packages with the | |
725 | @code{rust-} prefix. The name should be changed to lowercase as appropriate and | |
726 | dashes should remain in place. | |
727 | ||
728 | In the rust ecosystem it is common for multiple incompatible versions of a | |
729 | package to be used at any given time, so all packages should have a versioned | |
730 | suffix. If a package has passed version 1.0.0 then just the major version | |
731 | number is sufficient (e.g.@: @code{rust-clap-2}), otherwise the version suffix | |
732 | should contain both the major and minor version (e.g.@: @code{rust-rand-0.6}). | |
733 | ||
734 | Because of the difficulty in reusing rust packages as pre-compiled inputs for | |
735 | other packages the Cargo build system (@pxref{Build Systems, | |
736 | @code{cargo-build-system}}) presents the @code{#:cargo-inputs} and | |
737 | @code{cargo-development-inputs} keywords as build system arguments. It would be | |
738 | helpful to think of these as similar to @code{propagated-inputs} and | |
739 | @code{native-inputs}. Rust @code{dependencies} and @code{build-dependencies} | |
740 | should go in @code{#:cargo-inputs}, and @code{dev-dependencies} should go in | |
741 | @code{#:cargo-development-inputs}. If a Rust package links to other libraries | |
742 | then the standard placement in @code{inputs} and the like should be used. | |
743 | ||
744 | Care should be taken to ensure the correct version of dependencies are used; to | |
745 | this end we try to refrain from skipping the tests or using @code{#:skip-build?} | |
746 | when possible. Of course this is not always possible, as the package may be | |
747 | developed for a different Operating System, depend on features from the Nightly | |
748 | Rust compiler, or the test suite may have atrophied since it was released. | |
749 | ||
750 | ||
afe7408e LC |
751 | @node Fonts |
752 | @subsection Fonts | |
753 | ||
754 | @cindex fonts | |
755 | For fonts that are in general not installed by a user for typesetting | |
756 | purposes, or that are distributed as part of a larger software package, | |
757 | we rely on the general packaging rules for software; for instance, this | |
758 | applies to the fonts delivered as part of the X.Org system or fonts that | |
759 | are part of TeX Live. | |
760 | ||
761 | To make it easier for a user to search for fonts, names for other packages | |
762 | containing only fonts are constructed as follows, independently of the | |
763 | upstream package name. | |
764 | ||
765 | The name of a package containing only one font family starts with | |
766 | @code{font-}; it is followed by the foundry name and a dash @code{-} | |
767 | if the foundry is known, and the font family name, in which spaces are | |
768 | replaced by dashes (and as usual, all upper case letters are transformed | |
769 | to lower case). | |
770 | For example, the Gentium font family by SIL is packaged under the name | |
771 | @code{font-sil-gentium}. | |
772 | ||
773 | For a package containing several font families, the name of the collection | |
774 | is used in the place of the font family name. | |
775 | For instance, the Liberation fonts consist of three families, | |
776 | Liberation Sans, Liberation Serif and Liberation Mono. | |
777 | These could be packaged separately under the names | |
778 | @code{font-liberation-sans} and so on; but as they are distributed together | |
779 | under a common name, we prefer to package them together as | |
780 | @code{font-liberation}. | |
781 | ||
782 | In the case where several formats of the same font family or font collection | |
783 | are packaged separately, a short form of the format, prepended by a dash, | |
784 | is added to the package name. We use @code{-ttf} for TrueType fonts, | |
785 | @code{-otf} for OpenType fonts and @code{-type1} for PostScript Type 1 | |
786 | fonts. | |
787 | ||
788 | ||
8c01b9d0 ML |
789 | @node Coding Style |
790 | @section Coding Style | |
791 | ||
792 | In general our code follows the GNU Coding Standards (@pxref{Top,,, | |
793 | standards, GNU Coding Standards}). However, they do not say much about | |
794 | Scheme, so here are some additional rules. | |
795 | ||
796 | @menu | |
797 | * Programming Paradigm:: How to compose your elements. | |
798 | * Modules:: Where to store your code? | |
799 | * Data Types and Pattern Matching:: Implementing data structures. | |
800 | * Formatting Code:: Writing conventions. | |
801 | @end menu | |
802 | ||
803 | @node Programming Paradigm | |
804 | @subsection Programming Paradigm | |
805 | ||
806 | Scheme code in Guix is written in a purely functional style. One | |
807 | exception is code that involves input/output, and procedures that | |
808 | implement low-level concepts, such as the @code{memoize} procedure. | |
809 | ||
810 | @node Modules | |
811 | @subsection Modules | |
812 | ||
813 | Guile modules that are meant to be used on the builder side must live in | |
814 | the @code{(guix build @dots{})} name space. They must not refer to | |
815 | other Guix or GNU modules. However, it is OK for a ``host-side'' module | |
816 | to use a build-side module. | |
817 | ||
818 | Modules that deal with the broader GNU system should be in the | |
819 | @code{(gnu @dots{})} name space rather than @code{(guix @dots{})}. | |
820 | ||
821 | @node Data Types and Pattern Matching | |
822 | @subsection Data Types and Pattern Matching | |
823 | ||
824 | The tendency in classical Lisp is to use lists to represent everything, | |
825 | and then to browse them ``by hand'' using @code{car}, @code{cdr}, | |
826 | @code{cadr}, and co. There are several problems with that style, | |
827 | notably the fact that it is hard to read, error-prone, and a hindrance | |
828 | to proper type error reports. | |
829 | ||
830 | Guix code should define appropriate data types (for instance, using | |
831 | @code{define-record-type*}) rather than abuse lists. In addition, it | |
832 | should use pattern matching, via Guile’s @code{(ice-9 match)} module, | |
833 | especially when matching lists. | |
834 | ||
835 | @node Formatting Code | |
836 | @subsection Formatting Code | |
837 | ||
7bb2b10c LC |
838 | @cindex formatting code |
839 | @cindex coding style | |
8c01b9d0 ML |
840 | When writing Scheme code, we follow common wisdom among Scheme |
841 | programmers. In general, we follow the | |
21656ffa | 842 | @url{https://mumble.net/~campbell/scheme/style.txt, Riastradh's Lisp |
8c01b9d0 ML |
843 | Style Rules}. This document happens to describe the conventions mostly |
844 | used in Guile’s code too. It is very thoughtful and well written, so | |
845 | please do read it. | |
846 | ||
847 | Some special forms introduced in Guix, such as the @code{substitute*} | |
848 | macro, have special indentation rules. These are defined in the | |
8ca0c88a AK |
849 | @file{.dir-locals.el} file, which Emacs automatically uses. Also note |
850 | that Emacs-Guix provides @code{guix-devel-mode} mode that indents and | |
851 | highlights Guix code properly (@pxref{Development,,, emacs-guix, The | |
852 | Emacs-Guix Reference Manual}). | |
7bb2b10c LC |
853 | |
854 | @cindex indentation, of code | |
855 | @cindex formatting, of code | |
856 | If you do not use Emacs, please make sure to let your editor knows these | |
857 | rules. To automatically indent a package definition, you can also run: | |
858 | ||
859 | @example | |
557d9c8d | 860 | ./etc/indent-code.el gnu/packages/@var{file}.scm @var{package} |
7bb2b10c LC |
861 | @end example |
862 | ||
863 | @noindent | |
864 | This automatically indents the definition of @var{package} in | |
557d9c8d LC |
865 | @file{gnu/packages/@var{file}.scm} by running Emacs in batch mode. To |
866 | indent a whole file, omit the second argument: | |
867 | ||
868 | @example | |
869 | ./etc/indent-code.el gnu/services/@var{file}.scm | |
870 | @end example | |
8c01b9d0 | 871 | |
60912a88 LC |
872 | @cindex Vim, Scheme code editing |
873 | If you are editing code with Vim, we recommend that you run @code{:set | |
874 | autoindent} so that your code is automatically indented as you type. | |
875 | Additionally, | |
876 | @uref{https://www.vim.org/scripts/script.php?script_id=3998, | |
877 | @code{paredit.vim}} may help you deal with all these parentheses. | |
878 | ||
8c01b9d0 ML |
879 | We require all top-level procedures to carry a docstring. This |
880 | requirement can be relaxed for simple private procedures in the | |
881 | @code{(guix build @dots{})} name space, though. | |
882 | ||
883 | Procedures should not have more than four positional parameters. Use | |
884 | keyword parameters for procedures that take more than four parameters. | |
885 | ||
886 | ||
887 | @node Submitting Patches | |
888 | @section Submitting Patches | |
889 | ||
890 | Development is done using the Git distributed version control system. | |
891 | Thus, access to the repository is not strictly necessary. We welcome | |
892 | contributions in the form of patches as produced by @code{git | |
230efa87 | 893 | format-patch} sent to the @email{guix-patches@@gnu.org} mailing list. |
2d315cd4 LC |
894 | Seasoned Guix developers may also want to look at the section on commit |
895 | access (@pxref{Commit Access}). | |
230efa87 | 896 | |
a7bde77d LC |
897 | This mailing list is backed by a Debbugs instance, which allows us to |
898 | keep track of submissions (@pxref{Tracking Bugs and Patches}). Each | |
899 | message sent to that mailing list gets a new tracking number assigned; | |
900 | people can then follow up on the submission by sending email to | |
901 | @code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is the tracking | |
902 | number (@pxref{Sending a Patch Series}). | |
230efa87 | 903 | |
8c01b9d0 ML |
904 | Please write commit logs in the ChangeLog format (@pxref{Change Logs,,, |
905 | standards, GNU Coding Standards}); you can check the commit history for | |
906 | examples. | |
907 | ||
908 | Before submitting a patch that adds or modifies a package definition, | |
fcc58db6 LC |
909 | please run through this check list: |
910 | ||
911 | @enumerate | |
308c08d3 RW |
912 | @item |
913 | If the authors of the packaged software provide a cryptographic | |
914 | signature for the release tarball, make an effort to verify the | |
915 | authenticity of the archive. For a detached GPG signature file this | |
916 | would be done with the @code{gpg --verify} command. | |
917 | ||
cbd02397 LC |
918 | @item |
919 | Take some time to provide an adequate synopsis and description for the | |
920 | package. @xref{Synopses and Descriptions}, for some guidelines. | |
921 | ||
fcc58db6 LC |
922 | @item |
923 | Run @code{guix lint @var{package}}, where @var{package} is the | |
8c01b9d0 | 924 | name of the new or modified package, and fix any errors it reports |
fcc58db6 LC |
925 | (@pxref{Invoking guix lint}). |
926 | ||
927 | @item | |
928 | Make sure the package builds on your platform, using @code{guix build | |
929 | @var{package}}. | |
930 | ||
89339a35 DM |
931 | @item |
932 | We recommend you also try building the package on other supported | |
933 | platforms. As you may not have access to actual hardware platforms, we | |
934 | recommend using the @code{qemu-binfmt-service-type} to emulate them. In | |
935 | order to enable it, add the following service to the list of services in | |
936 | your @code{operating-system} configuration: | |
937 | ||
8ba31e8b | 938 | @lisp |
89339a35 DM |
939 | (service qemu-binfmt-service-type |
940 | (qemu-binfmt-configuration | |
b28e4e3c | 941 | (platforms (lookup-qemu-platforms "arm" "aarch64" "mips64el")) |
89339a35 | 942 | (guix-support? #t))) |
8ba31e8b | 943 | @end lisp |
89339a35 DM |
944 | |
945 | Then reconfigure your system. | |
946 | ||
947 | You can then build packages for different platforms by specifying the | |
948 | @code{--system} option. For example, to build the "hello" package for | |
b28e4e3c EF |
949 | the armhf, aarch64, or mips64 architectures, you would run the following |
950 | commands, respectively: | |
89339a35 DM |
951 | @example |
952 | guix build --system=armhf-linux --rounds=2 hello | |
953 | guix build --system=aarch64-linux --rounds=2 hello | |
89339a35 DM |
954 | guix build --system=mips64el-linux --rounds=2 hello |
955 | @end example | |
956 | ||
d222522e LC |
957 | @item |
958 | @cindex bundling | |
959 | Make sure the package does not use bundled copies of software already | |
960 | available as separate packages. | |
961 | ||
962 | Sometimes, packages include copies of the source code of their | |
963 | dependencies as a convenience for users. However, as a distribution, we | |
964 | want to make sure that such packages end up using the copy we already | |
965 | have in the distribution, if there is one. This improves resource usage | |
966 | (the dependency is built and stored only once), and allows the | |
967 | distribution to make transverse changes such as applying security | |
968 | updates for a given software package in a single place and have them | |
969 | affect the whole system---something that bundled copies prevent. | |
970 | ||
fcc58db6 LC |
971 | @item |
972 | Take a look at the profile reported by @command{guix size} | |
973 | (@pxref{Invoking guix size}). This will allow you to notice references | |
974 | to other packages unwillingly retained. It may also help determine | |
975 | whether to split the package (@pxref{Packages with Multiple Outputs}), | |
024e358c | 976 | and which optional dependencies should be used. In particular, avoid adding |
0afeb746 PN |
977 | @code{texlive} as a dependency: because of its extreme size, use |
978 | @code{texlive-tiny} or @code{texlive-union} instead. | |
fcc58db6 LC |
979 | |
980 | @item | |
981 | For important changes, check that dependent package (if applicable) are | |
982 | not affected by the change; @code{guix refresh --list-dependent | |
8c01b9d0 ML |
983 | @var{package}} will help you do that (@pxref{Invoking guix refresh}). |
984 | ||
916b5eba LC |
985 | @c See <https://lists.gnu.org/archive/html/guix-devel/2016-10/msg00933.html>. |
986 | @cindex branching strategy | |
987 | @cindex rebuild scheduling strategy | |
988 | Depending on the number of dependent packages and thus the amount of | |
989 | rebuilding induced, commits go to different branches, along these lines: | |
990 | ||
991 | @table @asis | |
992 | @item 300 dependent packages or less | |
993 | @code{master} branch (non-disruptive changes). | |
994 | ||
995 | @item between 300 and 1,200 dependent packages | |
996 | @code{staging} branch (non-disruptive changes). This branch is intended | |
997 | to be merged in @code{master} every 3 weeks or so. Topical changes | |
998 | (e.g., an update of the GNOME stack) can instead go to a specific branch | |
999 | (say, @code{gnome-updates}). | |
1000 | ||
1001 | @item more than 1,200 dependent packages | |
1002 | @code{core-updates} branch (may include major and potentially disruptive | |
1003 | changes). This branch is intended to be merged in @code{master} every | |
1004 | 2.5 months or so. | |
1005 | @end table | |
1006 | ||
44b5f28a | 1007 | All these branches are @uref{@value{SUBSTITUTE-SERVER}, |
38ab778f | 1008 | tracked by our build farm} and merged into @code{master} once |
189b1543 LC |
1009 | everything has been successfully built. This allows us to fix issues |
1010 | before they hit users, and to reduce the window during which pre-built | |
1011 | binaries are not available. | |
1012 | ||
38ab778f MB |
1013 | Generally, branches other than @code{master} are considered |
1014 | @emph{frozen} if there has been a recent evaluation, or there is a | |
1015 | corresponding @code{-next} branch. Please ask on the mailing list or | |
1016 | IRC if unsure where to place a patch. | |
1017 | @c TODO: It would be good with badges on the website that tracks these | |
1018 | @c branches. Or maybe even a status page. | |
1019 | ||
d23c20f1 | 1020 | @item |
5b74fe06 LC |
1021 | @cindex determinism, of build processes |
1022 | @cindex reproducible builds, checking | |
d23c20f1 LC |
1023 | Check whether the package's build process is deterministic. This |
1024 | typically means checking whether an independent build of the package | |
1025 | yields the exact same result that you obtained, bit for bit. | |
1026 | ||
5b74fe06 LC |
1027 | A simple way to do that is by building the same package several times in |
1028 | a row on your machine (@pxref{Invoking guix build}): | |
1029 | ||
1030 | @example | |
1031 | guix build --rounds=2 my-package | |
1032 | @end example | |
1033 | ||
1034 | This is enough to catch a class of common non-determinism issues, such | |
1035 | as timestamps or randomly-generated output in the build result. | |
1036 | ||
1037 | Another option is to use @command{guix challenge} (@pxref{Invoking guix | |
1038 | challenge}). You may run it once the package has been committed and | |
0bc02bec | 1039 | built by @code{@value{SUBSTITUTE-SERVER}} to check whether it obtains the same |
5b74fe06 LC |
1040 | result as you did. Better yet: Find another machine that can build it |
1041 | and run @command{guix publish}. Since the remote build machine is | |
1042 | likely different from yours, this can catch non-determinism issues | |
1043 | related to the hardware---e.g., use of different instruction set | |
1044 | extensions---or to the operating system kernel---e.g., reliance on | |
1045 | @code{uname} or @file{/proc} files. | |
d23c20f1 | 1046 | |
3c2d03a2 LC |
1047 | @item |
1048 | When writing documentation, please use gender-neutral wording when | |
1049 | referring to people, such as | |
1050 | @uref{https://en.wikipedia.org/wiki/Singular_they, singular | |
1051 | ``they''@comma{} ``their''@comma{} ``them''}, and so forth. | |
1052 | ||
3a78fab8 | 1053 | @item |
1054 | Verify that your patch contains only one set of related changes. | |
1055 | Bundling unrelated changes together makes reviewing harder and slower. | |
1056 | ||
1057 | Examples of unrelated changes include the addition of several packages, | |
1058 | or a package update along with fixes to that package. | |
1059 | ||
7bb2b10c LC |
1060 | @item |
1061 | Please follow our code formatting rules, possibly running the | |
557d9c8d | 1062 | @command{etc/indent-code.el} script to do that automatically for you |
7bb2b10c LC |
1063 | (@pxref{Formatting Code}). |
1064 | ||
4feb589b PN |
1065 | @item |
1066 | When possible, use mirrors in the source URL (@pxref{Invoking guix download}). | |
1067 | Use reliable URLs, not generated ones. For instance, GitHub archives are not | |
1068 | necessarily identical from one generation to the next, so in this case it's | |
1069 | often better to clone the repository. Don't use the @command{name} field in | |
1070 | the URL: it is not very useful and if the name changes, the URL will probably | |
1071 | be wrong. | |
1072 | ||
bf99d7e0 | 1073 | @item |
da31e7d9 PN |
1074 | Check if Guix builds (@pxref{Building from Git}) and address the |
1075 | warnings, especially those about use of undefined symbols. | |
bf99d7e0 | 1076 | |
9fcf2820 PN |
1077 | @item |
1078 | Make sure your changes do not break Guix and simulate a @code{guix pull} with: | |
1079 | @example | |
1080 | guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master | |
1081 | @end example | |
1082 | ||
fcc58db6 LC |
1083 | @end enumerate |
1084 | ||
a40424bd CM |
1085 | When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as |
1086 | a subject. You may use your email client or the @command{git | |
5a183a1e JN |
1087 | send-email} command (@pxref{Sending a Patch Series}). We prefer to get |
1088 | patches in plain text messages, either inline or as MIME attachments. | |
1089 | You are advised to pay attention if your email client changes anything | |
1090 | like line breaks or indentation which could potentially break the | |
1091 | patches. | |
1092 | ||
4619b59c JN |
1093 | When a bug is resolved, please close the thread by sending an email to |
1094 | @email{@var{NNN}-done@@debbugs.gnu.org}. | |
1095 | ||
5a183a1e JN |
1096 | @unnumberedsubsec Sending a Patch Series |
1097 | @anchor{Sending a Patch Series} | |
1098 | @cindex patch series | |
1099 | @cindex @code{git send-email} | |
1100 | @cindex @code{git-send-email} | |
1101 | ||
1102 | When sending a patch series (e.g., using @code{git send-email}), please | |
1103 | first send one message to @email{guix-patches@@gnu.org}, and then send | |
1104 | subsequent patches to @email{@var{NNN}@@debbugs.gnu.org} to make sure | |
1105 | they are kept together. See | |
1106 | @uref{https://debbugs.gnu.org/Advanced.html, the Debbugs documentation} | |
fb8b99a5 AB |
1107 | for more information. You can install @command{git send-email} with |
1108 | @command{guix install git:send-email}. | |
5a183a1e | 1109 | @c Debbugs bug: https://debbugs.gnu.org/db/15/15361.html |
a7bde77d LC |
1110 | |
1111 | @node Tracking Bugs and Patches | |
1112 | @section Tracking Bugs and Patches | |
1113 | ||
1114 | @cindex bug reports, tracking | |
1115 | @cindex patch submissions, tracking | |
1116 | @cindex issue tracking | |
1117 | @cindex Debbugs, issue tracking system | |
1118 | Bug reports and patch submissions are currently tracked using the | |
1119 | Debbugs instance at @uref{https://bugs.gnu.org}. Bug reports are filed | |
1120 | against the @code{guix} ``package'' (in Debbugs parlance), by sending | |
1121 | email to @email{bug-guix@@gnu.org}, while patch submissions are filed | |
1122 | against the @code{guix-patches} package by sending email to | |
1123 | @email{guix-patches@@gnu.org} (@pxref{Submitting Patches}). | |
1124 | ||
1125 | A web interface (actually @emph{two} web interfaces!) are available to | |
1126 | browse issues: | |
1127 | ||
1128 | @itemize | |
1129 | @item | |
1130 | @url{https://bugs.gnu.org/guix} lists bug reports; | |
1131 | @item | |
1132 | @url{https://bugs.gnu.org/guix-patches} lists patch submissions. | |
1133 | @end itemize | |
1134 | ||
1135 | You can also access both of these @i{via} the (nicer) | |
1136 | @url{https://issues.guix.gnu.org} interface@footnote{The web interface | |
1137 | at @url{https://issues.guix.gnu.org} is powered by Mumi, a nice piece of | |
1138 | software written in Guile, and you can help! See | |
1139 | @url{https://git.elephly.net/gitweb.cgi?p=software/mumi.git}.}. To view | |
1140 | discussions related to issue number @var{n}, go to | |
1141 | @indicateurl{https://issues.guix.gnu.org/issue/@var{n}} or | |
1142 | @indicateurl{https://bugs.gnu.org/@var{n}}. | |
1143 | ||
1144 | If you use Emacs, you may find it more convenient to interact with | |
1145 | issues using @file{debbugs.el}, which you can install with: | |
1146 | ||
1147 | @example | |
1148 | guix install emacs-debbugs | |
1149 | @end example | |
1150 | ||
1151 | For example, to list all open issues on @code{guix-patches}, hit: | |
1152 | ||
1153 | @example | |
1154 | @kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y | |
1155 | @end example | |
1156 | ||
1157 | @xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on | |
1158 | this nifty tool! | |
2d315cd4 LC |
1159 | |
1160 | @node Commit Access | |
1161 | @section Commit Access | |
1162 | ||
1163 | @cindex commit access, for developers | |
1164 | For frequent contributors, having write access to the repository is | |
ef09cb86 LC |
1165 | convenient. When you deem it necessary, consider applying for commit |
1166 | access by following these steps: | |
1167 | ||
1168 | @enumerate | |
1169 | @item | |
1170 | Find three committers who would vouch for you. You can view the list of | |
1171 | committers at | |
1172 | @url{https://savannah.gnu.org/project/memberlist.php?group=guix}. Each | |
1173 | of them should email a statement to @email{guix-maintainers@@gnu.org} (a | |
1174 | private alias for the collective of maintainers), signed with their | |
1175 | OpenPGP key. | |
1176 | ||
1177 | Committers are expected to have had some interactions with you as a | |
1178 | contributor and to be able to judge whether you are sufficiently | |
1179 | familiar with the project's practices. It is @emph{not} a judgment on | |
1180 | the value of your work, so a refusal should rather be interpreted as | |
1181 | ``let's try again later''. | |
1182 | ||
1183 | @item | |
1184 | Send @email{guix-maintainers@@gnu.org} a message stating your intent, | |
1185 | listing the three committers who support your application, signed with | |
1186 | the OpenPGP key you will use to sign commits, and giving its fingerprint | |
1187 | (see below). See @uref{https://emailselfdefense.fsf.org/en/}, for an | |
1188 | introduction to public-key cryptography with GnuPG. | |
1189 | ||
1190 | @item | |
1191 | Maintainers ultimately decide whether to grant you commit access, | |
1192 | usually following your referrals' recommendation. | |
1193 | ||
1194 | @item | |
1195 | If and once you've been given access, please send a message to | |
1196 | @email{guix-devel@@gnu.org} to say so, again signed with the OpenPGP key | |
1197 | you will use to sign commits (do that before pushing your first commit). | |
1198 | That way, everyone can notice and ensure you control that OpenPGP key. | |
1199 | ||
1200 | @c TODO: Add note about adding the fingerprint to the list of authorized | |
1201 | @c keys once that has stabilized. | |
1202 | ||
1203 | @item | |
1204 | Make sure to read the rest of this section and... profit! | |
1205 | @end enumerate | |
1206 | ||
1207 | @quotation Note | |
1208 | Maintainers are happy to give commit access to people who have been | |
1209 | contributing for some time and have a track record---don't be shy and | |
1210 | don't underestimate your work! | |
1211 | ||
1212 | However, note that the project is working towards a more automated patch | |
1213 | review and merging system, which, as a consequence, may lead us to have | |
1214 | fewer people with commit access to the main repository. Stay tuned! | |
1215 | @end quotation | |
1216 | ||
1217 | If you get commit access, please make sure to follow | |
2d315cd4 LC |
1218 | the policy below (discussions of the policy can take place on |
1219 | @email{guix-devel@@gnu.org}). | |
1220 | ||
1221 | Non-trivial patches should always be posted to | |
1222 | @email{guix-patches@@gnu.org} (trivial patches include fixing typos, | |
1223 | etc.). This mailing list fills the patch-tracking database | |
1224 | (@pxref{Tracking Bugs and Patches}). | |
1225 | ||
1226 | For patches that just add a new package, and a simple one, it's OK to | |
1227 | commit, if you're confident (which means you successfully built it in a | |
1228 | chroot setup, and have done a reasonable copyright and license | |
1229 | auditing). Likewise for package upgrades, except upgrades that trigger | |
1230 | a lot of rebuilds (for example, upgrading GnuTLS or GLib). We have a | |
1231 | mailing list for commit notifications (@email{guix-commits@@gnu.org}), | |
1232 | so people can notice. Before pushing your changes, make sure to run | |
1233 | @code{git pull --rebase}. | |
1234 | ||
1235 | All commits that are pushed to the central repository on Savannah must | |
1236 | be signed with an OpenPGP key, and the public key should be uploaded to | |
1237 | your user account on Savannah and to public key servers, such as | |
1238 | @code{keys.openpgp.org}. To configure Git to automatically sign | |
1239 | commits, run: | |
1240 | ||
1241 | @example | |
1242 | git config commit.gpgsign true | |
1243 | git config user.signingkey CABBA6EA1DC0FF33 | |
1244 | @end example | |
1245 | ||
1246 | You can prevent yourself from accidentally pushing unsigned commits to | |
1247 | Savannah by using the pre-push Git hook called located at | |
1248 | @file{etc/git/pre-push}: | |
1249 | ||
1250 | @example | |
1251 | cp etc/git/pre-push .git/hooks/pre-push | |
1252 | @end example | |
1253 | ||
1254 | When pushing a commit on behalf of somebody else, please add a | |
1255 | @code{Signed-off-by} line at the end of the commit log message---e.g., | |
1256 | with @command{git am --signoff}. This improves tracking of who did | |
1257 | what. | |
1258 | ||
1259 | For anything else, please post to @email{guix-patches@@gnu.org} and | |
1260 | leave time for a review, without committing anything (@pxref{Submitting | |
1261 | Patches}). If you didn’t receive any reply after two weeks, and if | |
1262 | you're confident, it's OK to commit. | |
1263 | ||
1264 | That last part is subject to being adjusted, allowing individuals to commit | |
1265 | directly on non-controversial changes on parts they’re familiar with. | |
98ebcf1c LC |
1266 | |
1267 | One last thing: the project keeps moving forward because committers not | |
1268 | only push their own awesome changes, but also offer some of their time | |
1269 | @emph{reviewing} and pushing other people's changes. As a committer, | |
1270 | you're welcome to use your expertise and commit rights to help other | |
1271 | contributors, too! |