From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mathieu Lirzin Subject: Re: [PATCH] doc: Merge 'HACKING' into Texinfo manual. Date: Thu, 11 Jun 2015 00:23:22 +0200 Message-ID: <871thjqk2t.fsf@openmailbox.org> References: <87mw09xg4z.fsf@openmailbox.org> <877frcdlea.fsf@gmail.com> <87eglj4ugc.fsf@openmailbox.org> <87pp53fijd.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:38196) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Z2oQ8-0001LF-QS for guix-devel@gnu.org; Wed, 10 Jun 2015 18:24:33 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Z2oQ4-0007bf-MA for guix-devel@gnu.org; Wed, 10 Jun 2015 18:24:28 -0400 Received: from smtp19.openmailbox.org ([62.4.1.53]:57430) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Z2oQ4-0007bN-3c for guix-devel@gnu.org; Wed, 10 Jun 2015 18:24:24 -0400 In-Reply-To: <87pp53fijd.fsf@gnu.org> ("Ludovic \=\?utf-8\?Q\?Court\=C3\=A8s\=22'\?\= \=\?utf-8\?Q\?s\?\= message of "Wed, 10 Jun 2015 21:52:06 +0200") List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org To: Ludovic =?utf-8?Q?Court=C3=A8s?= Cc: guix-devel@gnu.org, Alex Kost --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable ludo@gnu.org (Ludovic Court=C3=A8s) writes: > LGTM, please push! I noticed that I have forgot to update the detailed node listing. Here is the updated patch. :/ --=-=-= Content-Type: text/x-diff; charset=utf-8 Content-Disposition: inline; filename=0001-doc-Move-most-HACKING-informations-into-the-manual.patch Content-Transfer-Encoding: quoted-printable >From 51ac59f58dea877226827f5779e659aacdedf8a8 Mon Sep 17 00:00:00 2001 From: Mathieu Lirzin Date: Wed, 10 Jun 2015 13:39:54 +0200 Subject: [PATCH] doc: Move most 'HACKING' informations into the manual. * HACKING (Contributing): New section. (Building from Git, The Perfect Setup, Coding Style, Submitting Patches): Move to ... * doc/guix.texi (Running Guix Before It Is Installed): Likewise. (Contributing): ... here. * README (Installation): Adapt to it. * configure.ac (DOT): Likewise. --- HACKING | 133 ++--------------------------- README | 4 +- configure.ac | 2 +- doc/guix.texi | 268 ++++++++++++++++++++++++++++++++++++++++++++++++------= ---- 4 files changed, 233 insertions(+), 174 deletions(-) diff --git a/HACKING b/HACKING index 1e742c8..41838ee 100644 --- a/HACKING +++ b/HACKING @@ -2,141 +2,20 @@ =20 #+TITLE: Hacking GNU Guix and Its Incredible Distro =20 -Copyright =C2=A9 2012, 2013, 2014, 2015 Ludovic Court=C3=A8s -Copyright =C2=A9 2013 Nikita Karetnikov -Copyright =C2=A9 2014 Pierre-Antoine Rault +Copyright =C2=A9 2012, 2013, 2014 Ludovic Court=C3=A8s +Copyright =C2=A9 2015 Mathieu Lirzin =20 Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. =20 +* Contributing =20 -* Building from Git +See the manual for useful hacking informations, either by running =20 -When building Guix from a checkout, the following packages are required in -addition to those mentioned in the installation instructions: + info -f doc/guix.info "(guix) Contributing" =20 - - [[http://www.gnu.org/software/autoconf/][GNU Autoconf]] - - [[http://www.gnu.org/software/automake/][GNU Automake]] - - [[http://www.gnu.org/software/gettext/][GNU Gettext]] - - [[http://www.graphviz.org/][Graphviz]] - - [[http://www.gnu.org/software/help2man/][GNU Help2man]] (optional) - -Run =E2=80=98./bootstrap=E2=80=99 to download the Nix daemon source code a= nd to generate the -build system infrastructure using autoconf. It reports an error if an -inappropriate version of the above packages is being used. - -If you get an error like this one: - - configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES - -it probably means that Autoconf couldn=E2=80=99t find =E2=80=98pkg.m4=E2= =80=99, which is provided by -pkg-config. Make sure that =E2=80=98pkg.m4=E2=80=99 is available. For in= stance, if you -installed Automake in =E2=80=98/usr/local=E2=80=99, it wouldn=E2=80=99t lo= ok for =E2=80=98.m4=E2=80=99 files in -=E2=80=98/usr/share=E2=80=99. So you have to invoke the following command= in that case - - $ export ACLOCAL_PATH=3D/usr/share/aclocal - -See =E2=80=9Cinfo '(automake) Macro Search Path'=E2=80=9D for more informa= tion. - -Then, run =E2=80=98./configure=E2=80=99 as usual. - -Finally, you have to invoke =E2=80=98make check=E2=80=99 to run tests. If= anything fails, -take a look at =E2=80=9Cinfo '(guix) Installation'=E2=80=9D or send a mess= age to -. - -* Running Guix before it is installed - -See the same-named section in the manual. - -* The Perfect Setup - -The Perfect Setup to hack on Guix is basically the perfect setup used -for Guile hacking (info "(guile) Using Guile in Emacs"). First, you -need more than an editor, you need [[http://www.gnu.org/software/emacs][Em= acs]], empowered by the wonderful -[[http://nongnu.org/geiser/][Geiser]]. - -Geiser allows for interactive and incremental development from within -Emacs: code compilation and evaluation from within buffers, access to -on-line documentation (docstrings), context-sensitive completion, M-. to -jump to an object definition, a REPL to try out your code, and more. - -To actually edit the code, Emacs already has a neat Scheme mode. But in -addition to that, you must not miss [[http://www.emacswiki.org/emacs/ParEd= it][Paredit]]. It provides facilities to -directly operate on the syntax tree, such as raising an s-expression or -wrapping it, swallowing or rejecting the following s-expression, etc. - -* Submitting Patches - -Development is done using the Git distributed version control system. Thu= s, -access to the repository is not strictly necessary. We welcome contributi= ons -in the form of patches as produced by =E2=80=98git format-patch=E2=80=99 s= ent 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]]; you can check the commit history for examples. - -Before submitting a patch that adds or modifies a package definition, plea= se -run =E2=80=98guix lint PACKAGE=E2=80=99, where PACKAGE is the name of the = new or modified -package, and fix any errors it reports. In addition, please make sure the -package builds on your platform, using =E2=80=98guix build=E2=80=99. You = may also want to -check that dependent package (if applicable) are not affected by the chang= e; -=E2=80=98guix refresh --list-dependent PACKAGE=E2=80=99 will help you do t= hat. - -When posting a patch to the mailing list, use "[PATCH] ..." as a subject. = You -may use your email client or the =E2=80=98git send-mail=E2=80=99 command. - -As you become a regular contributor, you may find it convenient to have wr= ite -access to the repository (see below.) - -* Coding Style - -In general our code follows the [[info:standards][GNU Coding Standards]] (= GCS). However, the GCS -do not say much about Scheme, so here are some additional rules. - -** Programming Paradigm - -Scheme code in Guix is written in a purely functional style. One exceptio= n is -code that involves input/output, and procedures that implement low-level -concepts, such as the =E2=80=98memoize=E2=80=99 procedure. - -** Modules - -Guile modules that are meant to be used on the builder side must live in t= he -(guix build =E2=80=A6) name space. They must not refer to other Guix or G= NU modules. -However, it is OK for a =E2=80=9Chost-side=E2=80=9D module to use a build-= side module. - -Modules that deal with the broader GNU system should be in the (gnu =E2=80= =A6) name -space rather than (guix =E2=80=A6). - -** Data Types and Pattern Matching - -The tendency in classical Lisp is to use lists to represent everything, and -then to browse them =E2=80=9Cby hand=E2=80=9D using =E2=80=98car=E2=80=99,= =E2=80=98cdr=E2=80=99, =E2=80=98cadr=E2=80=99, and co. There are -several problems with that style, notably the fact that it is hard to read, -error-prone, and a hindrance to proper type error reports. - -Guix code should define appropriate data types (for instance, using -=E2=80=98define-record-type*=E2=80=99) rather than abuse lists. In additi= on, it should use -pattern matching, via Guile=E2=80=99s (ice-9 match) module, especially whe= n matching -lists. - -** Formatting Code - -When writing Scheme code, we follow common wisdom among Scheme programmers. -In general, we follow the [[http://mumble.net/~campbell/scheme/style.txt][= Riastradh's Lisp Style Rules]]. This document happens -to describe the conventions mostly used in Guile=E2=80=99s code too. It i= s very -thoughtful and well written, so please do read it. - -Some special forms introduced in Guix, such as the =E2=80=98substitute*=E2= =80=99 macro, have -special indentation rules. These are defined in the .dir-locals.el file, -which Emacs automatically uses. If you do not use Emacs, please make sure= to -let your editor know the rules. - -We require all top-level procedures to carry a docstring. This requirement -can be relaxed for simple private procedures in the (guix build =E2=80=A6)= name space, -though. - -Procedures should not have more than four positional parameters. Use keyw= ord -parameters for procedures that take more than four parameters. +or by checking the [[http://www.gnu.org/software/guix/manual/guix.html#Con= tributing][web copy of the manual]]. =20 * Commit Access =20 diff --git a/README b/README index 4d3367e..df52822 100644 --- a/README +++ b/README @@ -46,8 +46,8 @@ See the manual for the installation instructions, either = by running =20 or by checking the [[http://www.gnu.org/software/guix/manual/guix.html#Ins= tallation][web copy of the manual]]. =20 -For information on installation from a Git checkout, please see the =E2=80= =98HACKING=E2=80=99 -file. +For information on installation from a Git checkout, please see the section +"Building from Git" in the manual. =20 * Installing Guix from Guix =20 diff --git a/configure.ac b/configure.ac index 50b65fd..2c8b9f0 100644 --- a/configure.ac +++ b/configure.ac @@ -179,7 +179,7 @@ AC_CACHE_SAVE m4_include([config-daemon.ac]) =20 dnl `dot' (from the Graphviz package) is only needed for maintainers. -dnl See `HACKING' for more info. +dnl See `Building from Git' in the manual for more info. AM_MISSING_PROG([DOT], [dot]) =20 dnl Manual pages. diff --git a/doc/guix.texi b/doc/guix.texi index be7a292..d75ffba 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -13,6 +13,8 @@ Copyright @copyright{} 2012, 2013, 2014, 2015 Ludovic Court=C3=A8s@* Copyright @copyright{} 2013, 2014 Andreas Enge@* Copyright @copyright{} 2013 Nikita Karetnikov@* +Copyright @copyright{} 2015 Mathieu Lirzin@* +Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} 2015 Taylan Ulrich Bay=C4=B1rl=C4=B1/Kammer =20 Permission is granted to copy, distribute and/or modify this document @@ -88,7 +90,6 @@ Installation * Running the Test Suite:: Testing Guix. * Setting Up the Daemon:: Preparing the build daemon's environment. * Invoking guix-daemon:: Running the build daemon. -* Running Guix Before It Is Installed:: Hacker tricks. =20 Setting Up the Daemon =20 @@ -177,6 +178,21 @@ Packaging Guidelines * Perl Modules:: Little pearls. * Fonts:: Fond of fonts. =20 +Contributing + +* Building from Git:: The latest and greatest. +* Running Guix Before It Is Installed:: Hacker tricks. +* The Perfect Setup:: The right tools. +* Coding Style:: Hygiene of the contributor. +* Submitting Patches:: Share your work. + +Coding Style + +* Programming Paradigm:: How to compose your elements. +* Modules:: Where to store your code? +* Data Types and Pattern Matching:: Implementing data structures. +* Formatting Code:: Writing conventions. + @end detailmenu @end menu =20 @@ -253,7 +269,6 @@ instead, you want to install the complete GNU operating= system, * Running the Test Suite:: Testing Guix. * Setting Up the Daemon:: Preparing the build daemon's environment. * Invoking guix-daemon:: Running the build daemon. -* Running Guix Before It Is Installed:: Hacker tricks. @end menu =20 @node Binary Installation @@ -847,44 +862,6 @@ useful in exceptional circumstances, such as if you ne= ed to run several daemons on the same machine. @end table =20 -@node Running Guix Before It Is Installed -@section Running Guix Before It Is Installed - -If you are hacking Guix itself---which is a good idea!---you will find -it useful to test the changes made in your local source tree checkout -without actually installing them. - -To that end, all the command-line tools can be used even if you have not -run @command{make install}. To do that, prefix each command with -@command{./pre-inst-env} (the @file{pre-inst-env} script lives in the -top build tree of Guix), as in: - -@example -$ sudo ./pre-inst-env guix-daemon --build-users-group=3Dguixbuild -$ ./pre-inst-env guix build hello -@end example - -@noindent -Similarly, for a Guile session using the Guix modules: - -@example -$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system= ))' -@end example - -The @command{pre-inst-env} script sets up all the environment variables -necessary to support this, including @code{PATH} and -@code{GUILE_LOAD_PATH}. - -If you are hacking Guix from Emacs using the wonderful Geiser -(@pxref{Introduction,,, geiser, Geiser User Manual}), make sure to -augment Guile's load path so that it finds source files from your -checkout: - -@lisp -;; Assuming the Guix checkout is in ~/src/guix. -(add-to-list 'geiser-guile-load-path "~/src/guix") -@end lisp - =20 @c ********************************************************************* @node Package Management @@ -6792,10 +6769,213 @@ grow! Please get in touch with us on @email{guix-= devel@@gnu.org} and reports, patches, and anything that may be helpful to the project. We particularly welcome help on packaging (@pxref{Packaging Guidelines}). =20 -Please see the -@url{http://git.savannah.gnu.org/cgit/guix.git/tree/HACKING, -@file{HACKING} file} that comes with the Guix source code for practical -details about contributions. +@menu +* Building from Git:: The latest and greatest. +* Running Guix Before It Is Installed:: Hacker tricks. +* The Perfect Setup:: The right tools. +* Coding Style:: Hygiene of the contributor. +* Submitting Patches:: Share your work. +@end menu + +@node Building from Git +@section Building from Git + +If you want to hack Guix itself, it is recommended to use the latest +version from the Git repository. When building Guix from a checkout, +the following packages are required in addition to those mentioned in +the installation instructions (@pxref{Requirements}). + +@itemize +@item @url{http://gnu.org/software/autoconf/, GNU Autoconf}; +@item @url{http://gnu.org/software/automake/, GNU Automake}; +@item @url{http://gnu.org/software/gettext/, GNU Gettext}; +@item @url{http://www.graphviz.org/, Graphviz}; +@item @url{http://www.gnu.org/software/help2man/, GNU Help2man (optional)}. +@end itemize + +Run @command{./bootstrap} to download the Nix daemon source code and to +generate the build system infrastructure using autoconf. It reports an +error if an inappropriate version of the above packages is being used. + +@noindent +If you get an error like this one: + +@example +configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES +@end example + +it probably means that Autoconf couldn=E2=80=99t find @file{pkg.m4}, which= is +provided by @command{pkg-config}. Make sure that @file{pkg.m4} is +available. For instance, if you installed Automake in +@file{/usr/local}, it wouldn=E2=80=99t look for @file{.m4} files in +@file{/usr/share}. So you have to invoke the following command in that +case + +@example +export ACLOCAL_PATH=3D/usr/share/aclocal +@end example + +See @pxref{Macro Search Path,,, automake, The GNU Automake Manual} for +more information. + +Then, run @command{./configure} as usual. + +Finally, you have to invoke @code{make check} to run tests. If anything +fails, take a look at installation instructions (@pxref{Installation}) +or send a message to the @email{guix-devel@@gnu.org, mailing list}. + + +@node Running Guix Before It Is Installed +@section Running Guix Before It Is Installed + +In order to keep a sane working environment, you will find it useful to +test the changes made in your local source tree checkout without +actually installing them. So that you can distinguish between your +``end-user'' hat and your ``motley'' costume. + +To that end, all the command-line tools can be used even if you have not +run @code{make install}. To do that, prefix each command with +@command{./pre-inst-env} (the @file{pre-inst-env} script lives in the +top build tree of Guix), as in: + +@example +$ sudo ./pre-inst-env guix-daemon --build-users-group=3Dguixbuild +$ ./pre-inst-env guix build hello +@end example + +@noindent +Similarly, for a Guile session using the Guix modules: + +@example +$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system= ))' +@end example + +The @command{pre-inst-env} script sets up all the environment variables +necessary to support this, including @env{PATH} and @env{GUILE_LOAD_PATH}. + + +@node The Perfect Setup +@section The Perfect Setup + +The Perfect Setup to hack on Guix is basically the perfect setup used +for Guile hacking (@pxref{Using Guile in Emacs,,, guile, Guile Reference +Manual}). First, you need more than an editor, you need +@url{http://www.gnu.org/software/emacs, Emacs}, empowered by the +wonderful @url{http://nongnu.org/geiser/, Geiser}. + +Geiser allows for interactive and incremental development from within +Emacs: code compilation and evaluation from within buffers, access to +on-line documentation (docstrings), context-sensitive completion, +@kbd{M-.} to jump to an object definition, a REPL to try out your code, +and more (@pxref{Introduction,,, geiser, Geiser User Manual}). For +convenient Guix development, make sure to augment Guile=E2=80=99s load pat= h so +that it finds source files from your checkout: + +@lisp +;; @r{Assuming the Guix checkout is in ~/src/guix.} +(add-to-list 'geiser-guile-load-path "~/src/guix") +@end lisp + +To actually edit the code, Emacs already has a neat Scheme mode. But in +addition to that, you must not miss +@url{http://www.emacswiki.org/emacs/ParEdit, Paredit}. It provides +facilities to directly operate on the syntax tree, such as raising an +s-expression or wrapping it, swallowing or rejecting the following +s-expression, etc. + + +@node Coding Style +@section Coding Style + +In general our code follows the GNU Coding Standards (@pxref{Top,,, +standards, GNU Coding Standards}). However, they do not say much about +Scheme, so here are some additional rules. + +@menu +* Programming Paradigm:: How to compose your elements. +* Modules:: Where to store your code? +* Data Types and Pattern Matching:: Implementing data structures. +* Formatting Code:: Writing conventions. +@end menu + +@node Programming Paradigm +@subsection Programming Paradigm + +Scheme code in Guix is written in a purely functional style. One +exception is code that involves input/output, and procedures that +implement low-level concepts, such as the @code{memoize} procedure. + +@node Modules +@subsection Modules + +Guile modules that are meant to be used on the builder side must live in +the @code{(guix build @dots{})} name space. They must not refer to +other Guix or GNU modules. However, it is OK for a ``host-side'' module +to use a build-side module. + +Modules that deal with the broader GNU system should be in the +@code{(gnu @dots{})} name space rather than @code{(guix @dots{})}. + +@node Data Types and Pattern Matching +@subsection Data Types and Pattern Matching + +The tendency in classical Lisp is to use lists to represent everything, +and then to browse them ``by hand'' using @code{car}, @code{cdr}, +@code{cadr}, and co. There are several problems with that style, +notably the fact that it is hard to read, error-prone, and a hindrance +to proper type error reports. + +Guix code should define appropriate data types (for instance, using +@code{define-record-type*}) rather than abuse lists. In addition, it +should use pattern matching, via Guile=E2=80=99s @code{(ice-9 match)} modu= le, +especially when matching lists. + +@node Formatting Code +@subsection Formatting Code + +When writing Scheme code, we follow common wisdom among Scheme +programmers. In general, we follow the +@url{http://mumble.net/~campbell/scheme/style.txt, Riastradh's Lisp +Style Rules}. This document happens to describe the conventions mostly +used in Guile=E2=80=99s code too. It is very thoughtful and well written,= so +please do read it. + +Some special forms introduced in Guix, such as the @code{substitute*} +macro, have special indentation rules. These are defined in the +@file{.dir-locals.el} file, which Emacs automatically uses. If you do +not use Emacs, please make sure to let your editor know the rules. + +We require all top-level procedures to carry a docstring. This +requirement can be relaxed for simple private procedures in the +@code{(guix build @dots{})} name space, though. + +Procedures should not have more than four positional parameters. Use +keyword parameters for procedures that take more than four parameters. + + +@node Submitting Patches +@section Submitting Patches + +Development is done using the Git distributed version control system. +Thus, access to the repository is not strictly necessary. We welcome +contributions in the form of patches as produced by @code{git +format-patch} sent to the @email{guix-devel@@gnu.org, mailing list}. +Please write commit logs in the ChangeLog format (@pxref{Change Logs,,, +standards, GNU Coding Standards}); you can check the commit history for +examples. + +Before submitting a patch that adds or modifies a package definition, +please run @code{guix lint @var{package}}, where @var{package} is the +name of the new or modified package, and fix any errors it reports +(@pxref{Invoking guix lint}). In addition, please make sure the package +builds on your platform, using @code{guix build @var{package}}. You may +also want to check that dependent package (if applicable) are not +affected by the change; @code{guix refresh --list-dependent +@var{package}} will help you do that (@pxref{Invoking guix refresh}). + +When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as a +subject. You may use your email client or the @command{git send-mail} +command. =20 =20 @c ********************************************************************* --=20 2.1.4 --=-=-= Content-Type: text/plain -- Mathieu Lirzin --=-=-=--