From mboxrd@z Thu Jan  1 00:00:00 1970
From: ludo@gnu.org (Ludovic =?utf-8?Q?Court=C3=A8s?=)
Subject: Re: [PATCH] doc: Merge 'HACKING' into Texinfo manual.
Date: Wed, 10 Jun 2015 10:09:58 +0200
Message-ID: <87pp54htm1.fsf@gnu.org>
References: <87mw09xg4z.fsf@openmailbox.org>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Return-path: <guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([2001:4830:134:3::10]:42152)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <ludo@gnu.org>) id 1Z2b5L-00070S-0L
	for guix-devel@gnu.org; Wed, 10 Jun 2015 04:10:07 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <ludo@gnu.org>) id 1Z2b5F-0001hO-LB
	for guix-devel@gnu.org; Wed, 10 Jun 2015 04:10:06 -0400
In-Reply-To: <87mw09xg4z.fsf@openmailbox.org> (Mathieu Lirzin's message of
	"Tue, 09 Jun 2015 13:42:04 +0200")
List-Id: "Development of GNU Guix and the GNU System distribution."
	<guix-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/guix-devel>,
	<mailto:guix-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/archive/html/guix-devel>
List-Post: <mailto:guix-devel@gnu.org>
List-Help: <mailto:guix-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/guix-devel>,
	<mailto:guix-devel-request@gnu.org?subject=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: Mathieu Lirzin <mthl@openmailbox.org>
Cc: guix-devel@gnu.org

Mathieu Lirzin <mthl@openmailbox.org> skribis:

> do 'HACKING' copyright notices need to be added to the manual too?

Yes, please.  (We may have to compress the copyright lines eventually
for the PS/PDF output.)

> From ccbbddb5d5335b3714a4e6204498f1fc24dca6ab Mon Sep 17 00:00:00 2001
> From: Mathieu Lirzin <mthl@openmailbox.org>
> Date: Tue, 9 Jun 2015 00:08:43 +0200
> Subject: [PATCH] doc: Merge 'HACKING' into Texinfo manual.
>
> * HACKING: Delete file.
>   (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.
> * Makefile.am (EXTRA_DIST): Likewise.

LGTM, but it removes a bit too much: The =E2=80=9CCommit Access=E2=80=9D se=
ction
vanished.  Could you leave =E2=80=98HACKING=E2=80=99 with that section and =
a sentence
telling users to look at the =E2=80=9CContributing=E2=80=9D section of the =
manual?

> +Please write commit logs in the ChangeLog format (@pxref{Change Logs,,,
> +Standards, GNU Coding Standards}); you can check the commit history for
   ^
Should be lowercase =E2=80=9Cstandards=E2=80=9D (the name of the Info file.)

> +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.  In
                                                                     ^
Add: (@pxref{Invoking guix lint}).

> +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.
       ^
Add: (@pxref{Invoking guix refresh}).

Could you send an updated patch?

Thanks for working on it!

Ludo=E2=80=99.