Ludovic Courtès
d222522edf
doc: Discourage software bundling.
...
Fixes <http://bugs.gnu.org/24008 >.
Suggested by ng0 <ng0@we.make.ritual.n0.is>.
* doc/contributing.texi (Submitting Patches): Add item about bundling.
2016-07-28 15:41:00 +02:00
ng0
3a78fab83d
doc: Send changes in your patch which are related.
...
* doc/contributing.texi (Submitting Patches): New @item:
This gives information about sending related changes and examples on
what we view as related changes.
Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2016-07-28 15:38:14 +02:00
Ludovic Courtès
189b1543cb
doc: Mention separate branch for packages with many dependents.
...
Suggested by ng0 <ng0@we.make.ritual.n0.is>.
* doc/contributing.texi (Submitting Patches): Add note on packages with
more than 100 dependents.
2016-07-28 15:24:37 +02:00
ng0
0f53b886e2
doc: Point out preference of message format.
...
* doc/contributing.texi (Submitting Patches): Includes a note on
preference of plain text messages with either inline or MIME attachments
and advise contributers to pay attention if their email client breaks the
patches.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2016-07-24 19:54:15 +02:00
Ludovic Courtès
dfcdd9c25d
doc: Explain that contributors can use a pseudonym.
...
Suggested by ng0 <ng0@we.make.ritual.n0.is>.
* doc/contributing.texi (Contributing): Explain that using a legal name
is not required.
2016-07-24 19:54:15 +02:00
Ludovic Courtès
3c2d03a2b9
doc: Add note on gender-neutral wording.
...
Suggested by ng0 <ng0@we.make.ritual.n0.is>.
* doc/contributing.texi (Submitting Patches): Add @item regarding
gender-neutral wording.
2016-07-22 15:26:49 +02:00
Ludovic Courtès
3a25c63120
doc: Mention --localstatedir for when building from Git.
...
Reported by Hartmut Goebel <h.goebel@crazy-compilers.com>.
* doc/contributing.texi (Building from Git): Mention --localstatedir.
2016-04-16 00:52:19 +02:00
Christopher Allan Webber
b5f990a680
doc: Add footnote about pointing ~/.config/guix/latest at user's checkout
...
* doc/contributing.texi (Running Guix Before It Is Installed): New footnote.
2016-03-11 08:41:07 -08:00
Chris Marusich
a40424bd11
doc: Fix minor typos and add missing words.
...
* doc/guix.texi (Shepherd Services): Add missing words.
(Invoking guix system): Fix typo.
(Service Types and Services): Fix typo.
* doc/contributing.texi (Submitting Patches): Fix typo.
Signed-off-by: Andreas Enge <andreas@enge.fr>
2016-02-24 21:34:30 +01:00
Alex Sassmannshausen
dcb7119a6d
doc: rephrase code of conduct.
...
* doc/contributing.texi (Contributing): Rephrase 'code of conduct'
section.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2015-12-09 22:18:47 +01:00
Ludovic Courtès
e15fcdd149
Add "Contributor Covenant".
...
* CODE-OF-CONDUCT: New file, adapted from
<http://contributor-covenant.org/version/1/3/0/code_of_conduct.txt >.
* doc/contributing.texi (Contributing): Mention it.
* Makefile.am (EXTRA_DIST): Add it.
2015-12-09 14:29:41 +01:00
Ludovic Courtès
5b74fe065b
guix build: Add '--rounds'.
...
* guix/scripts/build.scm (show-build-options-help)
(%standard-build-options): Add --rounds.
(set-build-options-from-command-line): Honor it.
* doc/guix.texi (Invoking guix build): Document it.
* doc/contributing.texi (Submitting Patches): Mention it.
2015-12-08 23:58:12 +01:00
Ludovic Courtès
5fb95cc592
doc: Mention 'guix environment guix'.
...
* doc/contributing.texi (Building from Git): Mention 'guix environment
guix'. Remove outdated description of ./bootstrap. Clarify a few
things.
2015-11-22 14:14:25 +01:00
Ludovic Courtès
aabe6d3801
doc: Remove extraneous "See."
...
* doc/contributing.texi (Building from Git): Remove extra "See" and use
@xref instead of @pxref.
2015-11-21 22:26:13 +01:00
Alex Kost
bb38ece458
doc: Fix 'geiser-guile-load-path' example.
...
Reported by marusich on #guix.
* doc/contributing.texi (The Perfect Setup): Wrap modifying
'geiser-guile-load-path' into 'with-eval-after-load'.
2015-11-21 02:19:04 +03:00
Alex Vong
ef54b61dc6
doc: './pre-inst-env guix pull' won't upgrade local source tree.
...
* doc/contributing.texi (Running Guix Before It Is Installed): Clarify
'./pre-inst-env guix pull' won't upgrade local source tree.
* doc/guix.texi (Invoking guix pull): Mention ~/.config/guix/latest.
Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2015-11-03 09:56:48 +01:00
Mark H Weaver
0431ed00e4
doc: Add texinfo to the requirements when building from git.
...
* doc/contributing.texi (Building from Git): Add GNU Texinfo to the list of
additional requirements.
2015-10-28 12:04:02 +01:00
Ludovic Courtès
9685661324
doc: Add a REPL example.
...
* doc/contributing.texi (Running Guix Before It Is Installed): Add REPL
example.
* doc/emacs.texi (Emacs General info): Add @cindex.
2015-10-27 00:01:20 +01:00
Ludovic Courtès
d23c20f1d0
Add 'guix challenge'.
...
* guix/scripts/challenge.scm, tests/challenge.scm: New files.
* Makefile.am (MODULES): Add the former.
(SCM_TESTS): Add the latter.
* doc.am (SUBCOMMANDS): Add 'challenge'.
* doc/guix.texi (Substitutes): Add xref to 'guix challenge'.
(Invoking guix challenge): New node.
* doc/contributing.texi (Submitting Patches): Add note about using 'guix
challenge'.
* po/guix/POTFILES.in: Add guix/scripts/challenge.scm.
2015-10-20 00:57:36 +02:00
Alex Kost
187f80c6c5
emacs: Add development utils.
...
* emacs/guix-guile.el (guix-guile-current-module): New function.
* emacs/guix-devel.el: New file.
* emacs.am (ELFILES): Add it.
* doc/emacs.texi (Emacs Development): New node.
(Emacs Interface): Add it.
* doc/contributing.texi (The Perfect Setup): Mention it.
* doc/guix.texi (Top): Add it.
* emacs/guix-init.el: Add 'guix-devel-activate-mode-maybe' to
'scheme-mode-hook'.
2015-09-23 13:36:37 +03:00
Ludovic Courtès
cbd02397b5
doc: Add guidelines for synopses and descriptions.
...
* doc/guix.texi (Synopses and Descriptions): New node.
* doc/contributing.texi (Submitting Patches): Add item that
cross-references it.
2015-09-15 22:48:52 +02:00
Ludovic Courtès
fcc58db68b
Add 'guix size'.
...
* guix/scripts/size.scm: New file.
* Makefile.am (MODULES): Add it.
(SCM_TESTS): Add tests/size.scm.
* doc.am (SUBCOMMANDS): Add 'size'.
* po/guix/POTFILES.in: Add guix/scripts/size.scm.
* tests/size.scm: New file.
* doc/guix.texi (Packages with Multiple Outputs): Add xref to "Invoking guix
size".
(Invoking guix size): New node.
(Invoking guix gc): Add index for "closure" and xref to the above.
* doc/contributing.texi (Submitting Patches): Use @enumerate for the check
list. Add item about 'guix size'.
2015-06-18 00:36:09 +02:00
Mathieu Lirzin
8c01b9d05a
doc: Move most 'HACKING' informations into the manual.
...
* HACKING (Contributing): New section.
(Building from Git, The Perfect Setup, Coding Style, Submitting Patches):
Move to ...
* doc/guix.texi (Running Guix Before It Is Installed): Likewise.
* doc/contributing.texi: ... here. New file.
* doc.am (EXTRA_DIST): Use it.
* README (Installation): Adapt to it.
* configure.ac (DOT): Likewise.
2015-06-14 01:44:54 +02:00