summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
AgeCommit message (Expand)Author
2022-08-30etc: Add tempel snippets....* etc/snippets/tempel/scheme-mode: New file. * etc/snippets/tempel/text-mode: New file. * etc/snippets/scheme-mode: Moved from here... * etc/snippets/yas/scheme-mode: ... to here. * etc/snippets/text-mode: Moved from here... * etc/snippets/yas/text-mode: ... to here. * doc/contributing.texi ("The Perfect Setup"): Adjust yasnippet setup accordingly. Add tempel setup. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com> Nicolas Graves
2022-07-18doc: Fix the example of "Run `make` automatically"...* doc/contributing.texi (Running Guix Before It Is Installed): add missing command separator '--'. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Rostislav Svoboda
2022-07-15monad-repl: Add "build", "lower", and "verbosity" commands....Fixes <https://issues.guix.gnu.org/56114>. Reported by Maxime Devos <maximedevos@telenet.be>. * guix/monad-repl.scm (%build-verbosity): New variable. (evaluate/print-with-store): New procedure. (run-in-store): Rewrite in terms of 'evaluate/print-with-store'. (verbosity, lower, build): New meta-commands. * doc/guix.texi (Using Guix Interactively): New node. (The Store Monad): Link to it. (Invoking guix repl): Likewise. * doc/contributing.texi (Running Guix Before It Is Installed): Refer to it. (The Perfect Setup): Suggest 'guix install' rather than 'guix package -i'. Ludovic Courtès
2022-07-13doc: Prefer "guix show" over "guix package --show"....* doc/contributing.texi (Synopses and Descriptions): Use "guix show" instead of "guix package --show". Ludovic Courtès
2022-07-11doc: Fix cross-reference to Git Info manual....Partially fixes <https://issues.guix.gnu.org/55821>. Partially because our git package doesn't yet include the documentation. This change will need to go to core-updates. * doc/contributing.texi (Submitting Patches): Adjust the node name. Maxim Cournoyer
2022-07-07doc: 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> jgart
2022-05-22doc: 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. Tobias Geerinckx-Rice
2022-05-22import: 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> Philip McGrath
2022-05-22guix: 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> Philip McGrath
2022-04-02doc: Document inclusion requirements for new translations....* doc/contributing.texi (Translating Guix)[Conditions for Inclusion]: New section. Julien Lepiller
2022-02-15doc: 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}. Ludovic Courtès
2022-01-31doc: 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. Maxim Cournoyer
2022-01-28doc: 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> Guix Together
2022-01-28doc: 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> Guix Together
2022-01-10style: 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. Ludovic Courtès
2021-12-20doc: Remove extra closing paren....* doc/contributing.texi (Emacs Packages): Remove extra paren in example. Ludovic Courtès
2021-12-02doc: Give more details about generating patches with base commit information....* doc/contributing.texi (Submitting Patches): Talk more about '--base'. Leo Famulari
2021-11-17doc: 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> Rostislav Svoboda
2021-10-25Add '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". Ludovic Courtès
2021-10-14doc: Fix typo....* doc/contributing.texi (Configuring Git): s/respository/repository/ Marius Bakke
2021-10-04maint: 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> Sarah Morgensen
2021-09-22doc: 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> zimoun
2021-07-05doc: 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>. Chris Marusich
2021-06-23doc: 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. Chris Marusich
2021-06-18doc: 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. Ludovic Courtès
2021-06-18doc: Explain more reasons for commit revocation....* doc/contributing.texi (Commit Revocation): Expound. Ludovic Courtès
2021-06-18doc: Add "Addressing Issues" section....* doc/contributing.texi (Addressing Issues): New section. Co-authored-by: Christopher Baines <mail@cbaines.net> Ludovic Courtès
2021-06-18doc: Structure the "Commit Access" section....* doc/contributing.texi (Commit Access): Add introduction and section heading. Separate OpenPGP setup from commit policy. Ludovic Courtès
2021-06-18Start 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. Christopher Baines
2021-06-06doc: 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> Xinglu Chen
2021-06-06doc: Pluralize "package."...* doc/contributing.texi (Submitting Patches): Pluralize "package." Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr> Matthew James Kraai
2021-06-04doc: 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> Solene Rapenne
2021-05-30doc: Fix typos....* doc/contributing.texi (Translating Guix): Fix ‘runnig’ typo. Replace ‘target’ with ‘command’ to match the verb. Fix ‘refered’ and ‘formating’ too. Tobias Geerinckx-Rice
2021-05-25doc: Remove reference to mips64....* doc/contributing.texi (Submitting Patches): Don't suggest building packages for mips64. Efraim Flashner
2021-05-23doc: 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> Filip Lajszczak
2021-05-22doc: 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> Filip Lajszczak
2021-05-20The #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. Tobias Geerinckx-Rice
2021-05-13doc: Show how to enable Guile support for Geiser....* doc/contributing.texi (The Perfect Setup): Adjust "guix package -i" command line. Jelle Licht
2021-05-04doc: Fix typos....* doc/contributing.texi (Translating Guix): Fix ‘developpers’ and ‘superseeded’ typos. Use @var mark-up where appropriate. Tobias Geerinckx-Rice
2021-04-26doc: Clarify the utility of the development branches....* doc/contributing.texi (Submitting Patches): Clarify the utility of the 'staging' and 'core-updates' branches. Leo Famulari
2021-04-25doc: Document translation process....doc/contributing.texi (Translating Guix): New section. doc/guix.texi (Top): Add a reference to the new section. Julien Lepiller
2021-04-04doc: 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. Leo Famulari
2021-04-01doc: Discourage ambiguous package names....* doc/contributing.texi (Package Naming): Explicitly mention single-character and otherwise ambiguous names. Tobias Geerinckx-Rice via Bug reports for GNU Guix
2021-03-18doc: 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. Leo Famulari
2021-03-15services/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. Maxim Cournoyer
2021-03-10doc: Fix grammar....* doc/contributing.texi (Package Naming): Fix grammar. Tobias Geerinckx-Rice
2021-02-13doc: Try again to the improve the branching workflow....This is a followup to commit 175bea0ca42dba3e02109820efae0cac2804e73b. * doc/contributing.texi (Submitting Patches): Distill the workflow to its essence. Leo Famulari
2021-02-11doc: Try to improve the branching workflow....* doc/contributing.texi (Submitting Patches): Introduce the use of "-frozen" branch names. Leo Famulari
2021-01-29doc: Update guidance about Rust package naming....* doc/contributing.texi (Rust Crates): Explain versions suffix based on packages version and Crate "caret" versioning. Hartmut Goebel
2021-01-20doc: 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. Julien Lepiller