summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
Commit message (Collapse)AuthorAge
* 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.
* doc: Fix broken hyperlinks in the contribution instructions.Greg Hogan2020-09-18
| | | | | * doc/contributing.texi (Packaging Guidelines, Submitting Patches): Change URLs from relative to absolute links.
* doc: Document the use of snippets vs phases.Maxim Cournoyer2020-09-12
| | | | * doc/contributing.texi (Snippets versus phases): New section.
* doc: Improve the instructions regarding `guix git authenticate`.Joshua Branson2020-08-27
| | | | | | | * 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>
* doc: Recommend running 'guix git authenticate' when cloning the repo.Ludovic Courtès2020-07-23
| | | | | * doc/contributing.texi (Building from Git): Adjust instruction and recommend 'guix git authenticate'.
* doc: Fix typo.Tobias Geerinckx-Rice2020-07-09
| | | | * doc/contributing.texi (The Perfect Setup): Fix spelling & placement of ‘additionally’.
* doc: Make issues.guix.gnu.org more visible.Ludovic Courtès2020-06-20
| | | | | * doc/contributing.texi (Tracking Bugs and Patches): Make issues.guix.gnu.org more visible, update issue URL.
* doc: Recommend "make authenticate" after ./bootstrap.Ludovic Courtès2020-06-16
| | | | | * doc/contributing.texi (Building from Git): Move "make authenticate" instructions below.
* doc: Adjust branching and rebuilding strategy to match reality.Marius Bakke2020-06-14
| | | | | | | | | 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.
* doc: Remove explicit support for mips64el-linux.Efraim Flashner2020-05-28
| | | | | | | | | | | | | | | | | | 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.
* doc: Fix typos.zimoun2020-05-25
| | | | | | | * doc/guix.texi: Fix typos. * doc/contributing.texi: Fix typos. Signed-off-by: Julien Lepiller <julien@lepiller.eu>
* maint: Add "make check-channel-news".Ludovic Courtès2020-05-22
| | | | | | | * 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".
* doc: Specify the branch name in the title of a patch.Brice Waegeneire2020-05-12
| | | | | * doc/contributing.texi (Submitting Patches): Add branch name in the title of a patch if different than master.
* doc: Recommend against SHA1 OpenPGP signatures.Ludovic Courtès2020-05-04
| | | | | * doc/contributing.texi (Commit Access): Recommend against SHA1 signatures.
* doc: Document committer authorization.Ludovic Courtès2020-05-04
| | | | | * doc/contributing.texi (Commit Access): Add instructions for authorizing committers.
* doc: Update guidance about Python 2 package variants.Leo Famulari2020-03-13
| | | | | * doc/contributing.texi (Python Modules): Don't recommend adding Python-2 package variants by default.
* doc: Use HTTPS for external links.Vitaliy Shatrov2020-03-10
| | | | | | | | | | | | | | | | | | | | | | | | | * doc/contributing.texi (14.1 Building from Git, 14.3 The Perfect Setup, 14.4.1 Software Freedom, 14.4.4 Synopses and Descriptions, 14.5.4 Formatting Code): Use HTTPS for @uref{}s and @url{}s that support it. * doc/fdl-1.3.texi (Appendix A GNU Free Documentation License): Use HTTPS for @uref{}s and @url{}s that support it. * doc/guix.texi (6.3 Build Systems, 8.8.4 Networking Services, 8.8.8 Sound Services, 8.8.16 Web Services, 8.11 Name Service Switch, 12.2 Preparing to Use the Bootstrap Binaries); Use HTTPS for @uref{}s and @url{}s that support it. Signed-off-by: Marius Bakke <mbakke@fastmail.com>
* doc: Use an https link for Contributor Covenant.Jakub Kądziołka2020-03-09
| | | | | | | * doc/contributing.texi: Switch to https for the link to contributor-covenant.org Reported-By: guix-vits on IRC
* etc: Add copyright.Oleg Pykhalov2020-02-22
| | | | | * etc/copyright.el: New file. * doc/contributing.texi (The Perfect Setup): Document this.