summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
Commit message (Expand)AuthorAgeFilesLines
* 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>. Chris Marusich2021-07-051-8/+8
* 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. Chris Marusich2021-06-231-1/+65
* 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. Ludovic Courtès2021-06-181-1/+3
* doc: Explain more reasons for commit revocation.•••* doc/contributing.texi (Commit Revocation): Expound. Ludovic Courtès2021-06-181-0/+21
* doc: Add "Addressing Issues" section.•••* doc/contributing.texi (Addressing Issues): New section. Co-authored-by: Christopher Baines <mail@cbaines.net> Ludovic Courtès2021-06-181-0/+39
* doc: Structure the "Commit Access" section.•••* doc/contributing.texi (Commit Access): Add introduction and section heading. Separate OpenPGP setup from commit policy. Ludovic Courtès2021-06-181-20/+37
* 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. Christopher Baines2021-06-181-4/+4
* 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> Xinglu Chen2021-06-061-3/+19
* doc: Pluralize "package."•••* doc/contributing.texi (Submitting Patches): Pluralize "package." Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr> Matthew James Kraai2021-06-061-1/+1
* 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> Solene Rapenne2021-06-041-3/+4
* doc: 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-Rice2021-05-301-10/+10
* doc: Remove reference to mips64.•••* doc/contributing.texi (Submitting Patches): Don't suggest building packages for mips64. Efraim Flashner2021-05-251-1/+1
* 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> Filip Lajszczak2021-05-231-1/+1
* 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> Filip Lajszczak2021-05-221-0/+5
* 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. Tobias Geerinckx-Rice2021-05-201-1/+1
* doc: Show how to enable Guile support for Geiser.•••* doc/contributing.texi (The Perfect Setup): Adjust "guix package -i" command line. Jelle Licht2021-05-131-1/+1
* doc: Fix typos.•••* doc/contributing.texi (Translating Guix): Fix ‘developpers’ and ‘superseeded’ typos. Use @var mark-up where appropriate. Tobias Geerinckx-Rice2021-05-041-5/+5
* doc: Clarify the utility of the development branches.•••* doc/contributing.texi (Submitting Patches): Clarify the utility of the 'staging' and 'core-updates' branches. Leo Famulari2021-04-261-2/+4
* doc: Document translation process.•••doc/contributing.texi (Translating Guix): New section. doc/guix.texi (Top): Add a reference to the new section. Julien Lepiller2021-04-251-0/+264
* 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. Leo Famulari2021-04-041-4/+4
* doc: 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 Guix2021-04-011-0/+8
* 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. Leo Famulari2021-03-181-0/+6
* 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. Maxim Cournoyer2021-03-151-1/+0
* doc: Fix grammar.•••* doc/contributing.texi (Package Naming): Fix grammar. Tobias Geerinckx-Rice2021-03-101-1/+1
* doc: 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 Famulari2021-02-131-5/+5
* doc: Try to improve the branching workflow.•••* doc/contributing.texi (Submitting Patches): Introduce the use of "-frozen" branch names. Leo Famulari2021-02-111-4/+6
* doc: Update guidance about Rust package naming.•••* doc/contributing.texi (Rust Crates): Explain versions suffix based on packages version and Crate "caret" versioning. Hartmut Goebel2021-01-291-4/+4
* 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. Julien Lepiller2021-01-201-2/+2
* 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> Rovanion Luckey2021-01-031-8/+9
* doc: Emacs Packages: Fix typos.•••* doc/contributing.texi (Emacs Packages): Fix typo. Also remove spurious white space, and unnecessary quote. Nicolas Goaziou2020-12-171-3/+3
* doc: Add Emacs packaging guidelines.•••* doc/contributing.texi (Emacs Packages): New subsection. Maxim Cournoyer2020-12-171-0/+41
* doc: Note different texlive-tiny & texline-union natures.•••* doc/contributing.texi (Submitting Patches): Add ‘package’ and ‘procedure’. Inspired-by: Jorge P. de Morais Neto Tobias Geerinckx-Rice2020-12-141-1/+1
* 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. Ludovic Courtès2020-12-141-1/+2
* maint: update-guix-package: Optionally add sources to store.•••Following discussions in <https://issues.guix.gnu.org/43893>, keeping a copy of the updated package source is desirable when generating a release. * build-aux/update-guix-package.scm (version-controlled?): Remove variable. (call-with-temporary-git-worktree): Renamed from 'with-temporary-git-worktree'. Update doc. Do not change directory implicitly. Define as a procedure, not a syntax. (keep-source-in-store): New procedure. (main): Adjust to use with call-with-temporary-git-worktree. Add the sources to the store when GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT is set. Exit gracefully when FIND-ORIGIN-REMOTE returns #f. (%savannah-guix-git-repo-push-url-regexp): Adjust match for a potential colon separator. * Makefile.am (GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT): Adjust. * .dir-locals.el (scheme-mode): Remove entry for with-temporary-git-worktree. * doc/contributing.texi (Updating the Guix Package): Update doc. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Maxim Cournoyer2020-11-121-8/+3
* build: Add GUIX_GIT_KEYRING variable for make authenticate.•••* Makefile.am (GUIX_GIT_KEYRING): New variable. (authenticate): Use GUIX_GIT_KEYRING to select the keyring branch reference. * doc/contributing.texi (Building from Git): Add an example about the use of GUIX_GIT_KEYRING. Miguel Ángel Arruga Vivas2020-10-241-0/+10
* doc: More uses of @lisp instead of @example.•••* doc/guix.texi (G-Expressions): Use @lisp for 'let-system' example. * doc/contributing.texi (Synopses and Descriptions): Use @lisp for second example. Ludovic Courtès2020-10-201-2/+2
* maint: update-guix-package: Prevent accidentally breaking guix pull.•••Fixes <https://issues.guix.gnu.org/43893>. This changes the 'update-guix-package' tool so that it: 1. Always uses a clean checkout to compute the hash of the updated 'guix' package. 2. Ensures the commit used in the updated 'guix' package definition has already been pushed upstream. * build-aux/update-guix-package.scm (%savannah-guix-git-repo-push-url): New variable. (with-input-pipe-to-string, with-temporary-git-worktree): New syntaxes. (find-origin-remote, git-add-worktree): New procedures. (commit-already-pushed?): New predicate. (main): Check the commit used has already been pushed upstream and compute the hash from a clean checkout. * doc/contributing.texi (Updating the Guix Package): Document it. * .dir-locals.el (scheme-mode): Fix indentation of with-temporary-git-worktree. Maxim Cournoyer2020-10-191-0/+43
* doc: Clarify that guix-daemon doesn't have to be launched from the checkout.•••Suggested by Emmanuel Agullo. * doc/contributing.texi (Running Guix Before It Is Installed): Move the "./pre-inst-env guix-daemon" snippet at the bottom. Make it clear that it's necessary only when hacking on guix-daemon or when guix-daemon is not already running. Ludovic Courtès2020-10-081-5/+14
* doc: Developers don't need to run "make install" in Guix.•••Suggested by Emmanuel Agullo. * doc/contributing.texi (Building from Git): Mention that running "make install" is unnecessary. Ludovic Courtès2020-10-081-2/+3
* doc: Fix broken hyperlinks in the contribution instructions.•••* doc/contributing.texi (Packaging Guidelines, Submitting Patches): Change URLs from relative to absolute links. Greg Hogan2020-09-181-2/+2
* doc: Document the use of snippets vs phases.•••* doc/contributing.texi (Snippets versus phases): New section. Maxim Cournoyer2020-09-121-0/+15
* doc: Improve the instructions regarding `guix git authenticate`.•••* doc/contributing.texi (Building from Git): Instruct the user to fetch the 'keyring' branch. Fix a typo. Signed-off-by: Leo Famulari <leo@famulari.name> Joshua Branson2020-08-271-1/+2
* doc: Recommend running 'guix git authenticate' when cloning the repo.•••* doc/contributing.texi (Building from Git): Adjust instruction and recommend 'guix git authenticate'. Ludovic Courtès2020-07-231-19/+16
* doc: Fix typo.•••* doc/contributing.texi (The Perfect Setup): Fix spelling & placement of ‘additionally’. Tobias Geerinckx-Rice2020-07-091-1/+1
* doc: Make issues.guix.gnu.org more visible.•••* doc/contributing.texi (Tracking Bugs and Patches): Make issues.guix.gnu.org more visible, update issue URL. Ludovic Courtès2020-06-201-7/+9
* doc: Recommend "make authenticate" after ./bootstrap.•••* doc/contributing.texi (Building from Git): Move "make authenticate" instructions below. Ludovic Courtès2020-06-161-15/+15
* doc: Adjust branching and rebuilding strategy to match reality.•••The amount of packages has more than tripled since this section was written. Adjust the rebuild limits and cycle lengths based on current practices. * doc/contributing.texi (Submitting Patches): Increase 'staging' rebuild limit to 1800 packages, and adjust the cycle to six weeks. Increase 'core-updates' cycle to six months. Marius Bakke2020-06-141-4/+4
* doc: Remove explicit support for mips64el-linux.•••It's been a good run, but no one is maintaining the architecture. So long, and thanks for all the fish. * doc/guix.texi (GNU Distribution): Change text for mips64el-linux to denote it is deprecated. (Daemon Offload Setup): Change occurrences of mips64el-linux to aarch64-linux and adjust local code snippets. (Guix Environment)[cross-compilation]: Change mips64el-linux-gnu to aarch64-linux-gnu. (GNU Build System)(package-cross-derivation]: Same. (G-Expressions)[cross compilation]: Same. (Additional Build Options)[cross-compilation, build logs]: Same. (qemu-binfmt-service-type): Remove mips64el. * doc/contributing.texi (Submitting Patches): Same. * m4/guix.m4: (GUIX_ASSERT_SUPPORTED_SYSTEM): Remove mips64el-linux. Efraim Flashner2020-05-281-2/+1
* doc: Fix typos.•••* doc/guix.texi: Fix typos. * doc/contributing.texi: Fix typos. Signed-off-by: Julien Lepiller <julien@lepiller.eu> zimoun2020-05-251-1/+1
* maint: Add "make check-channel-news".•••* build-aux/check-channel-news.scm: New file. * Makefile.am (EXTRA_DIST): Add it. (check-channel-news): New phony rule. * doc/contributing.texi (Commit Access): Mention "make check-channel-news". Ludovic Courtès2020-05-221-0/+8