aboutsummaryrefslogtreecommitdiff
path: root/doc/contributing.texi
Commit message (Collapse)AuthorAge
* doc: Add a rule of thumb to guide enabling new committers.Maxim Cournoyer2022-01-31
| | | | | * doc/contributing.texi (Commit Access): Introduce a new rule of thumb to determine if a contributor should be considered to become a committer.
* doc: Mention how to remedy "source file ... newer than compiled error".Guix Together2022-01-28
| | | | | | | | | | | | * 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>
* doc: Explain the use of make clean-go when an ABI mismatch occurs.Guix Together2022-01-28
| | | | | | | | | | | * 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>
* style: Add '--styling' option.Ludovic Courtès2022-01-10
| | | | | | | | | | | | | | | | | | | * 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.
* doc: Remove extra closing paren.Ludovic Courtès2021-12-20
| | | | * doc/contributing.texi (Emacs Packages): Remove extra paren in example.
* doc: Give more details about generating patches with base commit information.Leo Famulari2021-12-02
| | | | * doc/contributing.texi (Submitting Patches): Talk more about '--base'.
* doc: Improve wording for param spec of `./configure`.Rostislav Svoboda2021-11-17
| | | | | | | * 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>
* Add 'guix shell'.Ludovic Courtès2021-10-25
| | | | | | | | | | | | | | | | | | | | | | | * 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".
* doc: Fix typo.Marius Bakke2021-10-14
| | | | * doc/contributing.texi (Configuring Git): s/respository/repository/
* maint: Improve default diff hunk header detection.Sarah Morgensen2021-10-04
| | | | | | | | | | | 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>
* doc: Add item to "Submitting Patches" section.zimoun2021-09-22
| | | | | | | * doc/contributing.texi (Submitting Patches): Add item about 'git-format-patch --base'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Change Debbugs usertags user to "guix".Chris Marusich2021-07-05
| | | | | | * 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>.
* doc: Document the use of Debbugs usertags.Chris Marusich2021-06-23
| | | | | | | | * 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.
* doc: Clarify Git commit signing; fix typo.Ludovic Courtès2021-06-18
| | | | | | | | 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.
* doc: Explain more reasons for commit revocation.Ludovic Courtès2021-06-18
| | | | * doc/contributing.texi (Commit Revocation): Expound.
* doc: Add "Addressing Issues" section.Ludovic Courtès2021-06-18
| | | | | | * doc/contributing.texi (Addressing Issues): New section. Co-authored-by: Christopher Baines <mail@cbaines.net>
* doc: Structure the "Commit Access" section.Ludovic Courtès2021-06-18
| | | | | * doc/contributing.texi (Commit Access): Add introduction and section heading. Separate OpenPGP setup from commit policy.
* Start enabling substitutes from bordeaux.guix.gnu.org.Christopher Baines2021-06-18
| | | | | | | | | | | | 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.
* doc: Add reference for ‘git-version’ and ‘hg-version’.Xinglu Chen2021-06-06
| | | | | | | | | * 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>
* doc: Pluralize "package."Matthew James Kraai2021-06-06
| | | | | | * doc/contributing.texi (Submitting Patches): Pluralize "package." Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr>
* doc: Mention virtualization module and add missing closing parenthesis.Solene Rapenne2021-06-04
| | | | | | | * doc/contributing.texi (Submitting Patches): Mention virtualization module and add missing closing parenthesis. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
* doc: Fix typos.Tobias Geerinckx-Rice2021-05-30
| | | | | | * doc/contributing.texi (Translating Guix): Fix ‘runnig’ typo. Replace ‘target’ with ‘command’ to match the verb. Fix ‘refered’ and ‘formating’ too.
* doc: Remove reference to mips64.Efraim Flashner2021-05-25
| | | | | * doc/contributing.texi (Submitting Patches): Don't suggest building packages for mips64.
* doc: Correct spellingFilip Lajszczak2021-05-23
| | | | | | | * 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>
* doc: Add information about first patch.Filip Lajszczak2021-05-22
| | | | | | * doc/contributing.texi (Submitting Patches): Add information about first patch acnowledgement delay. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* The #guix channel is hosted by Libera Chat.Tobias Geerinckx-Rice2021-05-20
| | | | | | | * README (Contact): Update network name. * ROADMAP: Likewise. * doc/contributing.texi (Contributing): Likewise. * doc/guix.texi (After System Installation): Likewise.
* doc: Show how to enable Guile support for Geiser.Jelle Licht2021-05-13
| | | | | * doc/contributing.texi (The Perfect Setup): Adjust "guix package -i" command line.
* doc: Fix typos.Tobias Geerinckx-Rice2021-05-04
| | | | | * doc/contributing.texi (Translating Guix): Fix ‘developpers’ and ‘superseeded’ typos. Use @var mark-up where appropriate.
* doc: Clarify the utility of the development branches.Leo Famulari2021-04-26
| | | | | * doc/contributing.texi (Submitting Patches): Clarify the utility of the 'staging' and 'core-updates' branches.
* doc: Document translation process.Julien Lepiller2021-04-25
| | | | | doc/contributing.texi (Translating Guix): New section. doc/guix.texi (Top): Add a reference to the new section.
* doc: Remind developers to build Guix.Leo Famulari2021-04-04
| | | | | | | | | | | 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.
* doc: Discourage ambiguous package names.Tobias Geerinckx-Rice via Bug reports for GNU Guix2021-04-01
| | | | | * doc/contributing.texi (Package Naming): Explicitly mention single-character and otherwise ambiguous names.
* doc: Document the guidelines for removing inactive committers.Leo Famulari2021-03-18
| | | | | | | For more context, see the discussion in <https://bugs.gnu.org/47111>. * doc/contributing.texi (Commit Access): Add paragraph about removing inactive committers.
* services/qemu-binfmt: Use the F flag and the static output of QEMU.Maxim Cournoyer2021-03-15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* doc: Fix grammar.Tobias Geerinckx-Rice2021-03-10
| | | | * doc/contributing.texi (Package Naming): Fix grammar.
* doc: Try again to the improve the branching workflow.Leo Famulari2021-02-13
| | | | | | | This is a followup to commit 175bea0ca42dba3e02109820efae0cac2804e73b. * doc/contributing.texi (Submitting Patches): Distill the workflow to its essence.
* doc: Try to improve the branching workflow.Leo Famulari2021-02-11
| | | | | * doc/contributing.texi (Submitting Patches): Introduce the use of "-frozen" branch names.
* doc: Update guidance about Rust package naming.Hartmut Goebel2021-01-29
| | | | | * doc/contributing.texi (Rust Crates): Explain versions suffix based on packages version and Crate "caret" versioning.
* doc: Replace TP with Weblate mentions.Julien Lepiller2021-01-20
| | | | | | * 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.
* doc: Running Guix Before It Is Installed: mention ./bootstrapRovanion Luckey2021-01-03
| | | | | | | * 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>
* doc: Emacs Packages: Fix typos.Nicolas Goaziou2020-12-17
| | | | | * doc/contributing.texi (Emacs Packages): Fix typo. Also remove spurious white space, and unnecessary quote.
* doc: Add Emacs packaging guidelines.Maxim Cournoyer2020-12-17
| | | | * doc/contributing.texi (Emacs Packages): New subsection.
* doc: Note different texlive-tiny & texline-union natures.Tobias Geerinckx-Rice2020-12-14
| | | | | | | * doc/contributing.texi (Submitting Patches): Add ‘package’ and ‘procedure’. Inspired-by: Jorge P. de Morais Neto
* doc: Link to "Pattern Matching" in Guile.Ludovic Courtès2020-12-14
| | | | | * doc/contributing.texi (Data Types and Pattern Matching): Link to the "Pattern Matching" node of the Guile manual.
* maint: update-guix-package: Optionally add sources to store.Maxim Cournoyer2020-11-12
| | | | | | | | | | | | | | | | | | | | | 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>
* build: Add GUIX_GIT_KEYRING variable for make authenticate.Miguel Ángel Arruga Vivas2020-10-24
| | | | | | | | * 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.
* doc: More uses of @lisp instead of @example.Ludovic Courtès2020-10-20
| | | | | | * doc/guix.texi (G-Expressions): Use @lisp for 'let-system' example. * doc/contributing.texi (Synopses and Descriptions): Use @lisp for second example.
* maint: update-guix-package: Prevent accidentally breaking guix pull.Maxim Cournoyer2020-10-19
| | | | | | | | | | | | | | | | | | | | | 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.
* doc: Clarify that guix-daemon doesn't have to be launched from the checkout.Ludovic Courtès2020-10-08
| | | | | | | | | 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.
* doc: Developers don't need to run "make install" in Guix.Ludovic Courtès2020-10-08
| | | | | | | Suggested by Emmanuel Agullo. * doc/contributing.texi (Building from Git): Mention that running "make install" is unnecessary.
generated by cgit v1.2.3 (git 2.45.0) at 2024-11-21 23:21:15 +0000