e103d61485
doc: Document the documentation process.
...
* doc/contributing.texi (Contributing): Add Writing Documentation section.
Co-authored-by: Julien Lepiller <julien@lepiller.eu>
Co-authored-by: Matt Trzcinski <matt@excalamus.com>
Co-authored-by: Fabio Natali <me@fabionatali.com>
Co-authored-by: Gabor Boskovits <boskovits@gmail.com>
Co-authored-by: Luis Felipe <luis.felipe.la@protonmail.com>
Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2022-07-07 14:40:50 -04:00
7649327da7
doc: Fix typos.
...
* doc/guix.texi (Guix Services): Fix ‘coresponding’ typo.
(Using cross-compilation): Fix ‘mecanism’ typo.
(Desktop Services): Fix ‘superceeded’ typo.
* doc/contributing.texi (Translating Guix): Fix ‘everytime’ typo.
2022-05-22 02:00:00 +02:00
903c82583e
import: Add Elm importer.
...
* guix/import/elm.scm, guix/scripts/import/elm.scm: New files.
* Makefile.am (MODULES): Add them.
* guix/scripts/import.scm (importers): Add "elm".
* doc/guix.texi (Invoking guix import): Document Elm importer.
* doc/contributing.texi (Elm Packages): Mention it.
* tests/elm.scm ("(guix import elm)"): New test group.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-05-22 01:07:52 +02:00
aefcfdd0ae
guix: Add elm-build-system.
...
* gnu/packages/patches/elm-offline-package-registry.patch: New file.
* gnu/local.mk (dist_patch_DATA): Add it.
* gnu/packages/elm.scm (elm): Use it.
* guix/build-system/elm.scm, guix/build/elm-build-system.scm,
tests/elm.scm: New files.
* Makefile.scm (MODULES, SCM_TESTS): Add them.
* doc/guix.texi (Build Systems): Document 'elm-build-system'.
* doc/contributing.texi (Elm Packages): New section. Document naming
conventions and utilities.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-05-22 01:07:51 +02:00
6386c011b2
doc: Document inclusion requirements for new translations.
...
* doc/contributing.texi (Translating Guix)[Conditions for Inclusion]:
New section.
2022-04-02 18:12:48 +02:00
8d472e9314
doc: Move build commands to @example for clarity.
...
* doc/contributing.texi (Building from Git): Tweak so that all the
commands appear in @example boxes. Show --localstatedir=/var instead of
--localstatedir=@var{directory}.
2022-02-15 10:29:09 +01:00
c1043fd60d
doc: Add a rule of thumb to guide enabling new committers.
...
* doc/contributing.texi (Commit Access): Introduce a new rule of thumb to
determine if a contributor should be considered to become a committer.
2022-01-31 23:38:52 -05:00
2f21931833
doc: Mention how to remedy "source file ... newer than compiled error".
...
* doc/contributing.texi (Running Guix Before It Is Installed): Mention
how to remedy "source file ... newer than compiled" error by running
`make -j`.
Co-authored-by: jgart <jgart@dismail.de>
Co-authored-by: Julien Lepiller <julien@lepiller.eu>
Co-authored-by: Ryan Prior <rprior@protonmail.com>
Co-authored-by: Blake Shaw <blake@nonconstructivism.com>
Signed-off-by: Nicolas Goaziou <mail@nicolasgoaziou.fr>
2022-01-28 10:15:26 +01:00
087ad097da
doc: Explain the use of make clean-go when an ABI mismatch occurs.
...
* doc/contributing.texi (Building from Git): Adds section on using
make clean-go.
Co-authored-by: jgart <jgart@dismail.de>
Co-authored-by: Julien Lepiller <julien@lepiller.eu>
Co-authored-by: Ryan Prior <rprior@protonmail.com>
Co-authored-by: Blake Shaw <blake@nonconstructivism.com>
Signed-off-by: Nicolas Goaziou <mail@nicolasgoaziou.fr>
2022-01-28 10:14:56 +01:00
c4fe13c294
style: Add '--styling' option.
...
* guix/scripts/style.scm (format-package-definition): New procedure.
(%options, show-help): Add "--styling".
(%default-options): Add 'styling-procedure'.
(guix-style): Honor it.
* tests/style.scm (with-test-package)
("input labels, 'safe' policy")
("input labels, 'safe' policy, nothing changed")
("input labels, margin comment")
("input labels, margin comment on long list")
("input labels, line comment")
("input labels, modify-inputs and margin comment"): Pass "-S inputs".
* etc/indent-code.el: Remove.
* doc/contributing.texi (Formatting Code): Mention "guix style" instead
of "etc/indent-code.el".
(Submitting Patches): Add item for "guix style".
* doc/guix.texi (Invoking guix style): Document "-S" and update.
2022-01-10 14:59:26 +01:00
2c469f04a3
doc: Remove extra closing paren.
...
* doc/contributing.texi (Emacs Packages): Remove extra paren in example.
2021-12-20 16:23:28 +01:00
f697fc267c
doc: Give more details about generating patches with base commit information.
...
* doc/contributing.texi (Submitting Patches): Talk more about '--base'.
2021-12-02 14:31:13 -05:00
fa67d6eef6
doc: Improve wording for param spec of `./configure`.
...
* doc/contributing.texi (Running Guix Before It Is Installed): Writing "Do
<this>. But it won't work unless ..." is a bad practice.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-17 23:05:58 +01:00
80edb7df65
Add 'guix shell'.
...
* guix/scripts/shell.scm, tests/guix-shell.sh: New files.
* Makefile.am (MODULES): Add 'shell.scm'.
(SH_TESTS): Add 'tests/guix-shell.sh'.
* guix/scripts/environment.scm (show-environment-options-help): New
procedure.
(show-help): Use it.
(guix-environment*): New procedure.
(guix-environment): Use it.
* po/guix/POTFILES.in: Add it.
* doc/guix.texi (Features): Refer to "guix shell"
(Invoking guix package): Likewise.
(Development): Likewise.
(Invoking guix shell): New node.
(Invoking guix environment): Add deprecation warning.
(Debugging Build Failures): Use 'guix shell' in examples.
(Invoking guix container): Refer to 'guix shell'.
(Invoking guix processes, Virtualization Services): Adjust examples to
use 'guix shell'.
* doc/contributing.texi (Building from Git): Refer to 'guix shell'.
* etc/completion/bash/guix: Handle "shell".
2021-10-25 18:58:18 +02:00
5fafb6e792
doc: Fix typo.
...
* doc/contributing.texi (Configuring Git): s/respository/repository/
2021-10-14 00:24:34 +02:00
9fc8ae4171
maint: Improve default diff hunk header detection.
...
Tell git where to look for diff hunk headers: top-level definitions for
Scheme files, and (sub)section headers for texi files.
* .gitattributes, etc/git/gitconfig: New files.
* doc/contributing.texi ("Submitting Patches"): Add subsection
"Configuring Git". Document etc/git/gitconfig.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-10-04 16:36:58 +02:00
d18b787d8a
doc: Add item to "Submitting Patches" section.
...
* doc/contributing.texi (Submitting Patches): Add item about 'git-format-patch
--base'.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-09-22 16:14:39 +02:00
586136d127
doc: Change Debbugs usertags user to "guix".
...
* doc/contributing.texi (Debbugs Usertags): Change the user for usertags from
"guix-devel@gnu.org" to "guix". This was discussed on the guix-devel email
list: <https://lists.gnu.org/archive/html/guix-devel/2021-06/msg00212.html >.
2021-07-05 21:11:13 -07:00
3c86372e36
doc: Document the use of Debbugs usertags.
...
* doc/contributing.texi (Contributing): Update the short description of the
"Tracking Bugs and Patches" chapter in the menu.
(Tracking Bugs and Patches): Split this section into three new subsections,
titled "The Issue Tracker", "Debbugs User Interfaces", and "Debbugs Usertags".
Of these, only the "Debbugs Usertags" is actually new.
2021-06-23 21:56:29 -07:00
b5b9266e40
doc: Clarify Git commit signing; fix typo.
...
Suggested by Maxime Devos <maximedevos@telenet.be>
and Julien Lepiller <julien@lepiller.eu>.
* doc/contributing.texi (Commit Access): Clarify Git commit signing
setup and fix typo.
2021-06-18 14:18:07 +02:00
d3d6d1c6eb
doc: Explain more reasons for commit revocation.
...
* doc/contributing.texi (Commit Revocation): Expound.
2021-06-18 14:18:07 +02:00
d475134245
doc: Add "Addressing Issues" section.
...
* doc/contributing.texi (Addressing Issues): New section.
Co-authored-by: Christopher Baines <mail@cbaines.net>
2021-06-18 14:18:07 +02:00
aaf4a0090f
doc: Structure the "Commit Access" section.
...
* doc/contributing.texi (Commit Access): Add introduction and section
heading. Separate OpenPGP setup from commit policy.
2021-06-18 14:18:07 +02:00
4985a42724
Start enabling substitutes from bordeaux.guix.gnu.org.
...
In addition to substitutes from ci.guix.gnu.org. There are more changes that
can be made in the future, but these changes seem like a good start.
* config-daemon.ac (guix_substitute_urls): Add https://bordeaux.guix.gnu.org .
* guix/scripts/substitute.scm (%default-substitute-urls): Add
http://bordeaux.guix.gnu.org .
* guix/store.scm (%default-substitute-urls): Add bordeaux.guix.gnu.org.
* doc/guix.texi: Adjust accordingly.
* doc/contributing.texi: Adjust accordingly.
2021-06-18 11:25:41 +01:00
b8baebae6a
doc: Add reference for ‘git-version’ and ‘hg-version’.
...
* doc/contributing.texi (Version Numbers): Document ‘git-version’ and
‘hg-version’.
* doc/guix.texi (package Reference): Reference ‘Version Numbers’ section for
version naming guidelines.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-06-06 23:12:17 +02:00
f7331f06db
doc: Pluralize "package."
...
* doc/contributing.texi (Submitting Patches): Pluralize "package."
Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr>
2021-06-06 15:10:57 +02:00
a9afff4beb
doc: Mention virtualization module and add missing closing parenthesis.
...
* doc/contributing.texi (Submitting Patches): Mention virtualization module
and add missing closing parenthesis.
Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-06-04 13:28:40 +02:00
d127fdd0e7
doc: Fix typos.
...
* doc/contributing.texi (Translating Guix): Fix ‘runnig’ typo. Replace
‘target’ with ‘command’ to match the verb. Fix ‘refered’ and ‘formating’
too.
2021-05-30 15:13:40 +02:00
de393bd027
doc: Remove reference to mips64.
...
* doc/contributing.texi (Submitting Patches): Don't suggest building
packages for mips64.
2021-05-25 10:54:27 +03:00
4b08aad5e7
doc: Correct spelling
...
* doc/contributing.tex (Submitting Patches): Correct spelling of "acknowledgement"
Co-authored-by: Piotr Kaznowski <piotr@kazno.dev>
Signed-off-by: Marius Bakke <marius@gnu.org>
2021-05-23 17:49:57 +02:00
c8d6fa7747
doc: Add information about first patch.
...
* doc/contributing.texi (Submitting Patches): Add information about first patch acnowledgement delay.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-05-22 23:44:57 +02:00
c0087d3370
The #guix channel is hosted by Libera Chat.
...
* README (Contact): Update network name.
* ROADMAP: Likewise.
* doc/contributing.texi (Contributing): Likewise.
* doc/guix.texi (After System Installation): Likewise.
2021-05-20 01:58:04 +02:00
bcdb8e9885
doc: Show how to enable Guile support for Geiser.
...
* doc/contributing.texi (The Perfect Setup): Adjust "guix package -i"
command line.
2021-05-13 23:28:36 +02:00
ef7275cd19
doc: Fix typos.
...
* doc/contributing.texi (Translating Guix): Fix ‘developpers’ and
‘superseeded’ typos. Use @var mark-up where appropriate.
2021-05-04 22:30:01 +02:00
4de688738c
doc: Clarify the utility of the development branches.
...
* doc/contributing.texi (Submitting Patches): Clarify the utility of the
'staging' and 'core-updates' branches.
2021-04-26 16:10:53 -04:00
1897a6efa7
doc: Document translation process.
...
doc/contributing.texi (Translating Guix): New section.
doc/guix.texi (Top): Add a reference to the new section.
2021-04-25 16:00:44 +02:00
5b97804e87
doc: Remind developers to build Guix.
...
The previous instructions were correct, but we got too many bug reports
with a root cause of "did not build Guix yet".
Other parts of the manual already instruct `make && make check`, so this
makes the treatment of building Guix more consistent, too.
* doc/contributing.texi (Building from Git): Instruct the user to run
`make` when building Guix.
2021-04-04 13:34:30 -04:00
1b1a61f86a
doc: Discourage ambiguous package names.
...
* doc/contributing.texi (Package Naming): Explicitly mention
single-character and otherwise ambiguous names.
2021-04-01 14:35:59 +02:00
9ade2b720a
doc: Document the guidelines for removing inactive committers.
...
For more context, see the discussion in <https://bugs.gnu.org/47111 >.
* doc/contributing.texi (Commit Access): Add paragraph about removing
inactive committers.
2021-03-18 16:09:11 -04:00
77c2f4e206
services/qemu-binfmt: Use the F flag and the static output of QEMU.
...
Fixes <https://issues.guix.gnu.org/36117 >.
Before this change, the 'binfmt_misc' entries registered for QEMU would not be
usable in container contexts outside of guix-daemon (without manually bind
mounting file names).
For example:
$ docker run --rm arm32v7/debian true
standard_init_linux.go:207: exec user process caused "no such file or directory"
After this change, any container can make use of the QEMU binfmt_misc
registrations, as their corresponding QEMU static binaries are fully
pre-loaded by the kernel.
* gnu/services/virtualization.scm (<qemu-platform>): Define using
'define-record-type*'.
[flags]: New field, which defaults to "F" (fix binary).
(%i386, %i486, %alpha, %arm, %armeb, %sparc, %sparc32plus, %ppc, %ppc64)
(%ppc64le, %m68k, %mips, %mipsel, %mipsn32, %mipsn32el, %mips64, %mips64el)
(%riscv32, %riscv64, %sh4, %sh4eb, %s390x, %aarch64, %hppa): Adjust.
(qemu-binfmt-guix-chroot): Remove variable.
(qemu-binfmt-service-type): Remove the qemu-binfmt-guix-chroot extension.
* gnu/services/qemu-binfmt (qemu-platform->binfmt): Use the static output of
QEMU.
* doc/contributing.texi (Submitting Patches): Update doc.
* doc/guix.texi (Virtualization Services): Update doc.
2021-03-15 18:00:35 -04:00
1dfc08f7ad
doc: Fix grammar.
...
* doc/contributing.texi (Package Naming): Fix grammar.
2021-03-10 01:16:07 +01:00
58853df8f6
doc: Try again to the improve the branching workflow.
...
This is a followup to commit 175bea0ca4
2021-02-13 13:19:15 -05:00
175bea0ca4
doc: Try to improve the branching workflow.
...
* doc/contributing.texi (Submitting Patches): Introduce the use of "-frozen"
branch names.
2021-02-11 16:13:39 -05:00
784048c27b
doc: Update guidance about Rust package naming.
...
* doc/contributing.texi (Rust Crates): Explain versions suffix based on
packages version and Crate "caret" versioning.
2021-01-29 22:51:23 +01:00
2a9784ffa2
doc: Replace TP with Weblate mentions.
...
* doc/contributing.texi: Replace link to TP with a link to Weblate.
* doc/guix.texi: Replace link to TP with a link to Weblate.
* doc/guix-cookbook.texi: Replace link to TP with a link to Weblate.
2021-01-20 16:16:45 +01:00
ad911c8321
doc: Running Guix Before It Is Installed: mention ./bootstrap
...
* doc/contributing.texi (Running Guix Before It Is Installed): Instruct
user to run ./bootstrap before ./configure.
Signed-off-by: Jakub Kądziołka <kuba@kadziolka.net>
2021-01-03 23:35:29 +01:00
eea7cc3185
doc: Emacs Packages: Fix typos.
...
* doc/contributing.texi (Emacs Packages): Fix typo. Also remove spurious white
space, and unnecessary quote.
2020-12-17 10:01:47 +01:00
15fba3b13d
doc: Add Emacs packaging guidelines.
...
* doc/contributing.texi (Emacs Packages): New subsection.
2020-12-17 00:51:49 -05:00
48cccf06ad
doc: Note different texlive-tiny & texline-union natures.
...
* doc/contributing.texi (Submitting Patches): Add ‘package’ and
‘procedure’.
Inspired-by: Jorge P. de Morais Neto
2020-12-14 19:11:03 +01:00
f06f569aa2
doc: Link to "Pattern Matching" in Guile.
...
* doc/contributing.texi (Data Types and Pattern Matching): Link to the
"Pattern Matching" node of the Guile manual.
2020-12-14 12:19:05 +01:00
jgart
Tobias Geerinckx-Rice
Philip McGrath
Julien Lepiller
Ludovic Courtès
Maxim Cournoyer
Leo Famulari
Rostislav Svoboda
Ludovic Courtès
Marius Bakke
Sarah Morgensen
zimoun
Chris Marusich
Christopher Baines
Xinglu Chen
Matthew James Kraai
Solene Rapenne
Efraim Flashner
Filip Lajszczak
Jelle Licht
Tobias Geerinckx-Rice via Bug reports for GNU Guix
Hartmut Goebel
Rovanion Luckey
Nicolas Goaziou