Re: [patch] - Packaging guideline documentation update
Pierre-Antoine Rault p...@rigelk.eu skribis: On 10/03/2014 21:56, Ludovic Courtès wrote: I’ve applied a stripped-down version of the patch: I ended up removing “Packaging 101” because it was redundant with the “Packaging Guidelines” section of the manual, so I moved the missing bits in that section (info (guix) Packaging Guidelines). I also removed details about how ‘git format-patch’ and co. work, because these commands already have their own manual. I admit it was overkill :) I realize the manual can be improved when it comes to introductory material. I would think of a (not so) short explaination of the guix tree as seen in the GNUnet manuel, for instance. What do you think ? Hmm, perhaps. Actually, part of the module name space is described here in there. For instance (gnu packages ...) is described under “Package Modules”, (guix build ...) is described under “Derivations”, etc. Perhaps a new section with cross-refs to these would help? Ludo’.
Re: [patch] - Packaging guideline documentation update
Cross-refs and a small glossary would help a lot to start with Guix. However, I was thinking about an explanation of folders, sub folders and main files as seen in the GNUnet manual [1]. [1] https://gnunet.org/book/export/html/37 Of course, these are just ideas to help brainstrom :) - rigelk l...@gnu.org a écrit : Pierre-Antoine Rault p...@rigelk.eu skribis: On 10/03/2014 21:56, Ludovic Courtès wrote: I’ve applied a stripped-down version of the patch: I ended up removing “Packaging 101” because it was redundant with the “Packaging Guidelines” section of the manual, so I moved the missing bits in that section (info (guix) Packaging Guidelines). I also removed details about how ‘git format-patch’ and co. work, because these commands already have their own manual. I admit it was overkill :) I realize the manual can be improved when it comes to introductory material. I would think of a (not so) short explaination of the guix tree as seen in the GNUnet manuel, for instance. What do you think ? Hmm, perhaps. Actually, part of the module name space is described here in there. For instance (gnu packages ...) is described under “Package Modules”, (guix build ...) is described under “Derivations”, etc. Perhaps a new section with cross-refs to these would help? Ludo’.
Re: [patch] - Packaging guideline documentation update
Pierre-Antoine Rault p...@rigelk.eu skribis: Cross-refs and a small glossary would help a lot to start with Guix. However, I was thinking about an explanation of folders, sub folders and main files as seen in the GNUnet manual [1]. [1] https://gnunet.org/book/export/html/37 Sure. Again part of the information is already in the manual, but it’s scattered in different places. So an improvement would be to have an overview section that would reference to the relevant sections. Ludo’.
Re: [patch] - Packaging guideline documentation update
Hi, Pierre-Antoine Rault p...@rigelk.eu skribis: Attached is a patch with basic explaination most of you know by heart, but that may not be obvious for newbies (like me). The details provided to the doc and hacking file both cover packaging and how to avoid the main pitfalls I've encountered myself recently. Most of them are based on advice from Dave, Mark_weaver (on #guix), these slides: http://www.gnu.org/software/guix/guix-ghm-andreas-20130823.pdf and these commands http://lists.gnu.org/archive/html/guix-devel/2013-12/msg00079.html What do you think ? Are there things to add ? (of course there are !) Thanks for the patch! I’ve applied a stripped-down version of the patch: I ended up removing “Packaging 101” because it was redundant with the “Packaging Guidelines” section of the manual, so I moved the missing bits in that section (info (guix) Packaging Guidelines). If you see anything still missing there, please do let me know; this should be the canonical place for such introductory material. I also removed details about how ‘git format-patch’ and co. work, because these commands already have their own manual. I realize the manual can be improved when it comes to introductory material. If you think of other improvements, please let’s make them in the “Packaging Guidelines” and “Defining Packages” sections. Thanks, Ludo’.
Re: [patch] - Packaging guideline documentation update
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi, On 10/03/2014 21:56, Ludovic Courtès wrote: I’ve applied a stripped-down version of the patch: I ended up removing “Packaging 101” because it was redundant with the “Packaging Guidelines” section of the manual, so I moved the missing bits in that section (info (guix) Packaging Guidelines). I also removed details about how ‘git format-patch’ and co. work, because these commands already have their own manual. I admit it was overkill :) I realize the manual can be improved when it comes to introductory material. I would think of a (not so) short explaination of the guix tree as seen in the GNUnet manuel, for instance. What do you think ? - - rigelk -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.22 (GNU/Linux) Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ iQEcBAEBAgAGBQJTHkaAAAoJEHfJ0QE7gLd6XSsIAIX5kQtsZmdJ6P8kSRo+0Euo YolTVuBs1BGbEq+sIx1nBPpzt1CYCuLkO/R/FzbKNpy2RmHwR/M2K1OEcr71hH2B DFIW65WEkTAZeouDRmU06leg+9I3EkQpJ6rqRmIyts9drUzRQoJdzkn0uZAROvSN hqBofvBQGvurvbBg+bjIW9UqObowsa9Bhg8lH0bLWpqA2CIzw8U3uWPTphHc5azH ML7lNYtdr7J95yMXsl/PN2DpiWiO8pG+uXPmBUanCgmipcAW5tU1VmC9Jp+LJBPU h1ke6Ym0wFsyFwuqzqC3INcOkwvGeM9yO7D/XNHVlQusY+FyRIkbEGeHyVkQ3Eg= =tuXM -END PGP SIGNATURE-
