all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: ludo@gnu.org (Ludovic Courtès)
To: Mathieu Lirzin <mthl@openmailbox.org>
Cc: guix-devel@gnu.org
Subject: Re: [PATCH] doc: Merge 'HACKING' into Texinfo manual.
Date: Wed, 10 Jun 2015 10:09:58 +0200	[thread overview]
Message-ID: <87pp54htm1.fsf@gnu.org> (raw)
In-Reply-To: <87mw09xg4z.fsf@openmailbox.org> (Mathieu Lirzin's message of "Tue, 09 Jun 2015 13:42:04 +0200")

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 “Commit Access” section
vanished.  Could you leave ‘HACKING’ with that section and a sentence
telling users to look at the “Contributing” 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 “standards” (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’.

  reply	other threads:[~2015-06-10  8:10 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-06-09 11:42 [PATCH] doc: Merge 'HACKING' into Texinfo manual Mathieu Lirzin
2015-06-10  8:09 ` Ludovic Courtès [this message]
2015-06-10  8:21 ` Alex Kost
2015-06-10 12:30   ` Mathieu Lirzin
2015-06-10 14:11     ` Alex Kost
2015-06-10 19:52     ` Ludovic Courtès
2015-06-10 22:23       ` Mathieu Lirzin
2015-06-11 14:05         ` Ludovic Courtès

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

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

  git send-email \
    --in-reply-to=87pp54htm1.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=guix-devel@gnu.org \
    --cc=mthl@openmailbox.org \
    /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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.