This adds an item about guix refresh to the contributing section of the
docs.
--
♥Ⓐ ng0
Current Keys: https://we.make.ritual.n0.is/ng0.txt
For non-prism friendly talk find me on http://www.psyced.org
>From 5fead8acf58b4ce000c60381a02db688561dbf05 Mon Sep 17 00:00:00 2001
From: ng0 <n...@we.make.ritual.n0.is>
Date: Thu, 28 Jul 2016 11:06:32 +0000
Subject: [PATCH] doc: Run guix refresh -l to find out about dependent
packages.
* doc/contributing.texi (Submitting Patches): Includes an item to
explain that core-updates and core-updates-next exist and that your
change will be applied on them if it affects too many dependent
packages, example: libgcrypt.
---
doc/contributing.texi | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/doc/contributing.texi b/doc/contributing.texi
index c0755bb..cfad190 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -328,6 +328,21 @@ extensions---or to the operating system kernel---e.g., reliance on
@code{uname} or @file{/proc} files.
@item
+Run @command{guix refresh --list-dependent} (@pxref{Invoking guix refresh})
+to find out how many packages would rebuild based on your patch.
+When your patch touches important or a big number of packages, it is
+prefered to be applied on the git branch core-updates or core-updates-next.
+
+@example
+guix refresh -l libgcrypt
+Building the following 822 packages would ensure 2221 dependent packages
+are rebuilt:
+@end example
+
+This is a good example for a number which indicates that a change to
+libgcrypt would not simply be applied on master.
+
+@item
When writing documentation, please use gender-neutral wording when
referring to people, such as
@uref{https://en.wikipedia.org/wiki/Singular_they, singular
--
2.9.2
