unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Luis Felipe López Acevedo" <felipe.lopez@openmailbox.org>
To: ludo@gnu.org
Cc: guix <guix-devel@gnu.org>, Feng Shu <tumashu@163.com>
Subject: Re: Merging ‘HACKING’ in the manual?
Date: Sun, 31 May 2015 19:38:02 -0500	[thread overview]
Message-ID: <7eb17310dde212e7cbc911e38178e9db@openmailbox.org> (raw)
In-Reply-To: <87k2vo4kqm.fsf_-_@gnu.org>

On 2015-05-31 14:20, ludo@gnu.org wrote:
> Mathieu Lirzin <mthl@openmailbox.org> skribis:
> 
>> When reacting, I didn't realize that most of your statement is 
>> actually
>> documented in the recent "Running Guix Before It Is Installed" node in
>> doc/guix.texi.
>> 
>> Nevertheless, I find it not really relevant to give hacking 
>> information
>> in chapter 'Installation'.
> 
> Agreed but...
> 
>> The attached patch tries to give a better consistency in the location
>> of these useful informations.
> 
> ... c71979f just did the opposite move, so no.  :-)
> 
>> Even if I find this patch appropriate ;-), my personnal preference 
>> would
>> be to delete HACKING, and move all its informations in the chapter
>> 'Contributing' of the Holy Bible (with appropriate refinement of
>> course!) and refer to it in README. Opinions about this?
> 
> Yeah, probably.  I’m not completely sure about moving things like patch
> submission and coding style in there; on one hand, it’s not something
> one would expect in a “user manual”, but on the other hand, it’s nice 
> to
> have everything consistently maintained in one place.
> 
> Another option would be to have a second .texi document for these 
> things
> (like Findutils, which has a ‘findutils-maint’ document.)
> 
> What do people think?

I like GNUnet's use of "handbooks" to separate information. They have 
Installation Handbook, User Handbook, and Developer Handbook. I think 
something similar could work well for Guix.


-- 
Luis Felipe López Acevedo

  reply	other threads:[~2015-06-01  0:38 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-22  0:27 Is it possible add 'Guix package manager without "make install"' to guix doc? Feng Shu
2015-05-22 16:03 ` Christopher Allan Webber
2015-05-22 16:30   ` Ludovic Courtès
2015-05-22 19:01     ` Christopher Allan Webber
2015-05-23 13:59       ` Ludovic Courtès
2015-05-23 17:22         ` Christopher Allan Webber
2015-05-27 19:49           ` Ludovic Courtès
2015-05-27 20:39             ` Mathieu Lirzin
2015-05-29 20:59               ` Ludovic Courtès
2015-05-30 13:53                 ` Mathieu Lirzin
2015-05-31 19:20                   ` Merging ‘HACKING’ in the manual? Ludovic Courtès
2015-06-01  0:38                     ` Luis Felipe López Acevedo [this message]
2015-06-01 19:34                       ` Ludovic Courtès
2015-06-01 19:58                         ` Ricardo Wurmus
2015-06-03  8:17                           ` Ludovic Courtès
2015-06-04 11:59                             ` Mathieu Lirzin
2015-06-01  7:06                     ` Alex Kost
2015-05-23 19:03         ` Is it possible add 'Guix package manager without "make install"' to guix doc? Alex Kost

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7eb17310dde212e7cbc911e38178e9db@openmailbox.org \
    --to=felipe.lopez@openmailbox.org \
    --cc=guix-devel@gnu.org \
    --cc=ludo@gnu.org \
    --cc=tumashu@163.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).