summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
AgeCommit message (Collapse)Author
2021-06-18doc: Clarify Git commit signing; fix typo.Ludovic Courtès
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-18doc: Explain more reasons for commit revocation.Ludovic Courtès
* doc/contributing.texi (Commit Revocation): Expound.
2021-06-18doc: Add "Addressing Issues" section.Ludovic Courtès
* doc/contributing.texi (Addressing Issues): New section. Co-authored-by: Christopher Baines <mail@cbaines.net>
2021-06-18doc: Structure the "Commit Access" section.Ludovic Courtès
* doc/contributing.texi (Commit Access): Add introduction and section heading. Separate OpenPGP setup from commit policy.
2021-06-18Start enabling substitutes from bordeaux.guix.gnu.org.Christopher Baines
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-06doc: Add reference for ‘git-version’ and ‘hg-version’.Xinglu Chen
* 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-06doc: Pluralize "package."Matthew James Kraai
* doc/contributing.texi (Submitting Patches): Pluralize "package." Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr>
2021-06-04doc: Mention virtualization module and add missing closing parenthesis.Solene Rapenne
* doc/contributing.texi (Submitting Patches): Mention virtualization module and add missing closing parenthesis. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-05-30doc: Fix typos.Tobias Geerinckx-Rice
* doc/contributing.texi (Translating Guix): Fix ‘runnig’ typo. Replace ‘target’ with ‘command’ to match the verb. Fix ‘refered’ and ‘formating’ too.
2021-05-25doc: Remove reference to mips64.Efraim Flashner
* doc/contributing.texi (Submitting Patches): Don't suggest building packages for mips64.
2021-05-23doc: Correct spellingFilip Lajszczak
* 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-22doc: Add information about first patch.Filip Lajszczak
* doc/contributing.texi (Submitting Patches): Add information about first patch acnowledgement delay. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-05-20The #guix channel is hosted by Libera Chat.Tobias Geerinckx-Rice
* README (Contact): Update network name. * ROADMAP: Likewise. * doc/contributing.texi (Contributing): Likewise. * doc/guix.texi (After System Installation): Likewise.
2021-05-13doc: Show how to enable Guile support for Geiser.Jelle Licht
* doc/contributing.texi (The Perfect Setup): Adjust "guix package -i" command line.
2021-05-04doc: Fix typos.Tobias Geerinckx-Rice
* doc/contributing.texi (Translating Guix): Fix ‘developpers’ and ‘superseeded’ typos. Use @var mark-up where appropriate.
2021-04-26doc: Clarify the utility of the development branches.Leo Famulari
* doc/contributing.texi (Submitting Patches): Clarify the utility of the 'staging' and 'core-updates' branches.
2021-04-25doc: Document translation process.Julien Lepiller
doc/contributing.texi (Translating Guix): New section. doc/guix.texi (Top): Add a reference to the new section.
2021-04-04doc: Remind developers to build Guix.Leo Famulari
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-01doc: Discourage ambiguous package names.Tobias Geerinckx-Rice via Bug reports for GNU Guix
* doc/contributing.texi (Package Naming): Explicitly mention single-character and otherwise ambiguous names.
2021-03-18doc: Document the guidelines for removing inactive committers.Leo Famulari
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-15services/qemu-binfmt: Use the F flag and the static output of QEMU.Maxim Cournoyer
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-10doc: Fix grammar.Tobias Geerinckx-Rice
* doc/contributing.texi (Package Naming): Fix grammar.
2021-02-13doc: Try again to the improve the branching workflow.Leo Famulari
This is a followup to commit 175bea0ca42dba3e02109820efae0cac2804e73b. * doc/contributing.texi (Submitting Patches): Distill the workflow to its essence.
2021-02-11doc: Try to improve the branching workflow.Leo Famulari
* doc/contributing.texi (Submitting Patches): Introduce the use of "-frozen" branch names.
2021-01-29doc: Update guidance about Rust package naming.Hartmut Goebel
* doc/contributing.texi (Rust Crates): Explain versions suffix based on packages version and Crate "caret" versioning.
2021-01-20doc: Replace TP with Weblate mentions.Julien Lepiller
* 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-03doc: Running Guix Before It Is Installed: mention ./bootstrapRovanion Luckey
* 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>
2020-12-17doc: Emacs Packages: Fix typos.Nicolas Goaziou
* doc/contributing.texi (Emacs Packages): Fix typo. Also remove spurious white space, and unnecessary quote.
2020-12-17doc: Add Emacs packaging guidelines.Maxim Cournoyer
* doc/contributing.texi (Emacs Packages): New subsection.
2020-12-14doc: Note different texlive-tiny & texline-union natures.Tobias Geerinckx-Rice
* doc/contributing.texi (Submitting Patches): Add ‘package’ and ‘procedure’. Inspired-by: Jorge P. de Morais Neto
2020-12-14doc: Link to "Pattern Matching" in Guile.Ludovic Courtès
* doc/contributing.texi (Data Types and Pattern Matching): Link to the "Pattern Matching" node of the Guile manual.
2020-11-12maint: update-guix-package: Optionally add sources to store.Maxim Cournoyer
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>
2020-10-24build: Add GUIX_GIT_KEYRING variable for make authenticate.Miguel Ángel Arruga Vivas
* 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.
2020-10-20doc: More uses of @lisp instead of @example.Ludovic Courtès
* doc/guix.texi (G-Expressions): Use @lisp for 'let-system' example. * doc/contributing.texi (Synopses and Descriptions): Use @lisp for second example.
2020-10-19maint: update-guix-package: Prevent accidentally breaking guix pull.Maxim Cournoyer
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.
2020-10-08doc: Clarify that guix-daemon doesn't have to be launched from the checkout.Ludovic Courtès
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.
2020-10-08doc: Developers don't need to run "make install" in Guix.Ludovic Courtès
Suggested by Emmanuel Agullo. * doc/contributing.texi (Building from Git): Mention that running "make install" is unnecessary.
2020-09-18doc: Fix broken hyperlinks in the contribution instructions.Greg Hogan
* doc/contributing.texi (Packaging Guidelines, Submitting Patches): Change URLs from relative to absolute links.
2020-09-12doc: Document the use of snippets vs phases.Maxim Cournoyer
* doc/contributing.texi (Snippets versus phases): New section.
2020-08-27doc: Improve the instructions regarding `guix git authenticate`.Joshua Branson
* 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>
2020-07-23doc: Recommend running 'guix git authenticate' when cloning the repo.Ludovic Courtès
* doc/contributing.texi (Building from Git): Adjust instruction and recommend 'guix git authenticate'.
2020-07-09doc: Fix typo.Tobias Geerinckx-Rice
* doc/contributing.texi (The Perfect Setup): Fix spelling & placement of ‘additionally’.
2020-06-20doc: Make issues.guix.gnu.org more visible.Ludovic Courtès
* doc/contributing.texi (Tracking Bugs and Patches): Make issues.guix.gnu.org more visible, update issue URL.
2020-06-16doc: Recommend "make authenticate" after ./bootstrap.Ludovic Courtès
* doc/contributing.texi (Building from Git): Move "make authenticate" instructions below.
2020-06-14doc: Adjust branching and rebuilding strategy to match reality.Marius Bakke
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.
2020-05-28doc: Remove explicit support for mips64el-linux.Efraim Flashner
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.
2020-05-25doc: Fix typos.zimoun
* doc/guix.texi: Fix typos. * doc/contributing.texi: Fix typos. Signed-off-by: Julien Lepiller <julien@lepiller.eu>
2020-05-22maint: Add "make check-channel-news".Ludovic Courtès
* 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".
2020-05-12doc: Specify the branch name in the title of a patch.Brice Waegeneire
* doc/contributing.texi (Submitting Patches): Add branch name in the title of a patch if different than master.
2020-05-04doc: Recommend against SHA1 OpenPGP signatures.Ludovic Courtès
* doc/contributing.texi (Commit Access): Recommend against SHA1 signatures.
generated by cgit v1.2.3 (git 2.44.0) at 2024-07-05 12:15:14 +0000