summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
AgeCommit message (Collapse)Author
2026-03-08doc: Remove mention of python-toolchain.Sharlatan Hellseher
* doc/contributing.texi (Python Moduels): Drop mention of python-toolchain. * guix/build-system/pyproject.scm: Likewise. Fixes: guix/guix#5841 Change-Id: I39a1ec7ce6da2e5f3298323b36070c3e3b197669
2026-03-03doc: Refresh python documentation.Nicolas Graves
* doc/contributing.texi: Refresh python documentation (avoid uses of "we " and "you", remove the reference to pyproject-build-system as experimental, and adjust the setuptools situation comments). Merges: https://codeberg.org/guix/guix/pulls/6427 Change-Id: Idb065befc975063ad97e6bdafb724e50d6891cb5 Reviewed-by: Yan Abu Arab <yanabuarab@gmail.com> Reviewed-by: Maxim Cournoyer <maxim@guixotic.coop> Signed-off-by: Sharlatan Hellseher <sharlatanus@gmail.com>
2026-02-03doc: Document “standard” pull requests and AGit.Ludovic Courtès
* doc/contributing.texi (Submitting Patches): Document “standard” pull requests and AGit. Merges guix/guix!5840 Change-Id: I8fe93e4dde0b9543f3bd99c66cf1fdb6ba69c449 Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-02-03doc: Remove “Debbugs Usertags” section.Ludovic Courtès
* doc/contributing.texi (Debbugs Usertags): Remove. Merges guix/guix!5840 Change-Id: If550e31918c495ed24578fcbaaa179eb36521687 Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-02-03doc: Update Debbugs deprecation warnings.Ludovic Courtès
* doc/contributing.texi (The Issue Tracker): Update deprecation notice. (Debbugs User Interfaces): Likewise. Merges guix/guix!5840 Change-Id: Ic5c1bddddbb8c53b031d52887f57372759badf8b Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-02-03doc: Remove “Sending a Patch Series” section.Ludovic Courtès
* doc/contributing.texi (Sending a Patch Series): Remove. Merges guix/guix!5840 Change-Id: I8f15c4385b24cecc6a8f1bd13c2065d2a267e5b1 Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-02-03doc: Contributions are now made on Codeberg.Ludovic Courtès
* doc/contributing.texi (Submitting Patches): Document Codeberg pull requests as the only method. Mention guix-patches@gnu.org in a footnote. Remove paragraphs about of ‘git send-email’ and the associated workflow. Merges guix/guix!5840 Reported-by: Nick Blumenauer <nicknb@posteo.com> Change-Id: Ifbd46665a14a83f014ddff4234cc69bf93c3a8d1 Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-01-27serialization: Use ‘bytevector-slice’ from Guile >= 3.0.9.Ludovic Courtès
* guix/serialization.scm (sub-bytevector): Remove. (read-byte-string): Use ‘bytevector-slice’. * configure.ac: Require Guile 3.0.9. * doc/contributing.texi (Requirements): Adjust accordingly. Change-Id: I7aa11a2182530ea5131be591db03b17efb6847a4 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #4495
2026-01-05doc: Better explain extra development tools when building from git.Hugo Buddelmeijer
* doc/contributing.texi (Building from Git): Better explain adding tools. Change-Id: I47fb9e5414edc5eebce64d25db6998cc51985fcb Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #4821
2026-01-05doc: Explain that some test require network when building from git.Hugo Buddelmeijer
* doc/contributing.texi (Building from Git): Discuss network tests. Change-Id: I21c8e4a1e60ed215a6fb3507b7aedc1835f735ad Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-01-05doc: Improve building from git instructions.Hugo Buddelmeijer
* doc/contributing.texi (Building from Git): Improve instructions. Include 'cd' and authorizing the directory for guix shell. Change-Id: Ied8eb7553ab92504a87c0059820ca154a18c33ab Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2025-12-23doc: Briefly discuss default git branch name.Hugo Buddelmeijer
* doc/contributing.texi (Building from git): Discuss branch name. Change-Id: I9ddb9318749c7974a8724355c1a6b18a98fa9e8e Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2025-10-23doc: Recommend ‘define-deprecated-package’ in the Deprecation Policy.Ludovic Courtès
* doc/contributing.texi (Deprecation Policy): Document and recommend ‘define-deprecated-package’. Change-Id: I530310f5216f09025525d91f690bb3885fe2cfb4
2025-09-23doc: Clarify how to create the Codeberg token for `sync-codeberg-teams'.Maxim Cournoyer
* doc/contributing.texi (Teams): Mention needed permissions and provide the page URL. Change-Id: I4ba44379a4ce5df9e987b32f28ebac0c7dc35618
2025-09-16doc: Remove broken link.Gabriel Wicki
* doc/contributing.texi: Delete sentence with broken link. Change-Id: I2f0b67e1fa70750414e30d7cd474e1d4d077d9e8
2025-08-28doc: Add link to issues and pull requests with the ‘deprecation’ label.Ludovic Courtès
* doc/contributing.texi (Deprecation Policy): Add note with link to issues and pull requests with the ‘deprecation’ label. Change-Id: If5e833e20c11796f961f48e086c54fdbb9155dd1
2025-08-23doc: Increase minimum Guile-Git version.Morgan Arnold
* doc/contributing.text: bump minimum required version of guile-git from 0.5.0 to 0.10.0, required by 86022e994e. * po/doc/guix-manual.*: update translations as well. Change-Id: I8cc8fd720cc71fbe17e2e530f7411b9c888ba0f6 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2025-08-21doc: Document lockfile importer based Rust packaging workflow.Hilton Chain
* doc/guix.texi (Build Systems) [cargo-build-system]: Add cross-reference for the term "Cargo workspaces". * doc/contributing.texi (Packaging Guidelines)[Rust Crates]: Update documentation. * doc/guix-cookbook.texi (Packaging)[Packaging Workflow]: New section. * gnu/packages/rust-crates.scm, * gnu/packages/rust-sources.scm: Stop mentioning guix-rust-registry for now, we may remove the repository if future merges are managed well. Change-Id: Ic0c6378cf5f5df97d6f8bdd040b486be62c7bddc
2025-08-06doc: Fix some typos.Efraim Flashner
* doc/contributing.texi (Bulk Updates): Fix typo. * doc/guix.texi (Networking Services, Power Management Services, Guix Services, Backup Home Services): Same. Change-Id: I4ebde33ad628e35ea2c1888b8247707ab3763cf1
2025-07-12doc: Fix some grammar.cdr-shdr-wdr
* doc/contributing.texi (Alternative Setups): Fix grammar, add double space. (Sending a Patch Series): Add missing word. * doc/guix.texi (Daemon Offload Setup, Invoking guix repl): Fix grammar. (Bootloader Configuration): Fix grammar, capitalize "RAM". Change-Id: I459c8343b28b2b3474c7a54372f75c61c8111a10 Signed-off-by: Danny Milosavljevic <dannym@friendly-machines.com>
2025-07-09doc: Update weblate URL.Julien Lepiller
* doc/build.scm (stylized-html): Update URL from fedora to codeberg's Weblate. * doc/contributing.texi: idem. * doc/guix-cookbook.texi: idem. * doc/guix.texi: idem. Change-Id: I13729a73f94738c9c336a067058020549f2640d6
2025-07-01doc: More typographical tweaks for “Bulk Updates” section.Ludovic Courtès
* doc/contributing.texi (Bulk Updates): Capitalize title. Leave two spaces after end-of-sentence period. Use @dots{} instead of showing full store file names, as per ‘assert-no-store-file-names’ target. Fix typo. Change-Id: Iceb0079ec35fda95280afff1c0d4b2cd84717b96
2025-07-01doc: contributing: Correct typos in Bulk updates.Sergey Trofimov
* doc/contributing.texi (Bulk updates): Correct typos. Change-Id: I660520b64139537e6ca9186c06810f5053d4368e Signed-off-by: Ludovic Courtès <ludo@gnu.org> Modified-by: Ludovic Courtès <ludo@gnu.org>
2025-06-23doc: contributing: Fix broken example.Jelle Licht
* doc/contributing.texi (Bulk updates): Properly escape special characters. Change-Id: I9aa4d88f19904056546717cd80ca89ab2f5924fe
2025-06-23doc: Document bulk updates.Sharlatan Hellseher
* doc/contributing.texi (Bulk updates): New section describing update technique for collection of packages. Change-Id: Ic67978a6c8e0140980a0ede968f7e411faf23a1d Signed-off-by: jgart <jgart@dismail.de>
2025-06-12doc: Fix typo.Ludovic Courtès
* doc/contributing.texi (The Issue Tracker): Fix typo. Change-Id: Ibcc93fa13bcb8a5bc902e6ce743b43b7973608e4
2025-06-09doc: Document ‘etc/teams.scm sync-codeberg-teams’.Ludovic Courtès
* doc/contributing.texi (Teams): Document ‘sync-codeberg-teams’. Change-Id: I0a32c78b26f3687ed744a29a9d768b5ee597d932
2025-06-09doc: Mention Codeberg issues and pull requests.Ludovic Courtès
* doc/contributing.texi (Submitting Patches): Describe the two options, Codeberg and Debbugs. (Sending a Patch Series): Add deprecation warning. (The Issue Tracker): Mention Codeberg. (Managing Patches and Branches): Remove initial reference to guix-patches. (Debbugs User Interfaces): Add deprecation warning. (Reviewing the Work of Others): Mention pull request approval. Change-Id: Ibf21e8923e555db1e14107ad87a65bf45f9f3fc3
2025-06-06doc: contributing: Disable authentication when simulating ‘guix pull’.Hilton Chain
* doc/contributing.texi (Submitting Patches): Add ‘--disable-authentication’ when simulating ‘guix pull’. * .forgejo/pull_request_template.md: Likewise. Fixes: #427 Change-Id: I4c6847314c8876a2f6e29f938cbbbe286178231b
2025-05-26doc: contributing: Fix grammar.Jos van den Oever
* doc/contributing.texi (Formatting Code): Fix grammar. Change-Id: I0f1304b22068146855b6148d4f0952fe32caebdb Signed-off-by: Hilton Chain <hako@ultrarare.space> Modified-by: Hilton Chain <hako@ultrarare.space>
2025-05-25doc: Update Guile-JSON URL.Ludovic Courtès
* doc/contributing.texi (Requirements): Update. Change-Id: I365b65da2ffc17b9140271a11e5899c4fc4ba6df
2025-05-25doc: Replace Savannah URLs with Codeberg URLs.Ludovic Courtès
* doc/contributing.texi (Requirements): Update Guix web site URL. (Sending a Patch Series): Replace Savannah URLs with Codeberg URLs. (Debbugs User Interfaces): Likewise. (Commit Access): Likewise. (Updating the Guix Package): Likewise. (Coding): Likewise. (System Administration): Likewise. (Day-to-Day System Administration): Likewise. * doc/guix.texi (Web Services): Likewise. Change-Id: I5c6532f3e02e8870f869dd4ab844eed3cb0cb242
2025-05-23teams: Add “codeowners” action.Ludovic Courtès
* etc/teams.scm (team->codeowners-snippet, export-codeowners): New procedures. (main): Add “codeowners” action. * doc/contributing.texi (Teams): Document it. Change-Id: I601443981af374d85160833f7096d8c973873fb1
2025-05-23maint: Change main repository URL to git.guix.gnu.org.Ludovic Courtès
Throughout, replace “https://git.savannah.gnu.org/git/guix.git” by “https://git.guix.gnu.org/guix.git”. Change-Id: Ieb82464f92a806b85c79e629f952e68c39323740
2025-05-06gnu: Rename `texlive-updmap.cfg' into `texlive-local-tree'.Nicolas Goaziou
* doc/build.scm (pdf-manual): * doc/contributing.texi (Submitting Patches): * gnu/packages/algebra.scm (pari-gp): (giac): * gnu/packages/assembly.scm (asl): * gnu/packages/audio.scm (chow-tape-model): * gnu/packages/bioconductor.scm (r-biocstyle): * gnu/packages/bioinformatics.scm (discrover): (phyml): (velvet): * gnu/packages/chemistry.scm (yaehmop): * gnu/packages/chez.scm (chez-scheme-for-racket): (stex-bootstrap): (chez-web): (chez-sockets): * gnu/packages/cran.scm (r-papaja): (r-prereg): * gnu/packages/docbook.scm (dblatex): * gnu/packages/emacs-xyz.scm (emacs-auctex): * gnu/packages/engineering.scm (fastcap): * gnu/packages/finance.scm (optionmatrix): * gnu/packages/fsf.scm (book-faif): * gnu/packages/gettext.scm (po4a): (po4a-minimal): * gnu/packages/graphics.scm (mmg): * gnu/packages/graphviz.scm (dot2tex): * gnu/packages/guile-xyz.scm (emacsy): (guile-cv): * gnu/packages/lisp.scm (sbcl): * gnu/packages/maths.scm (cddlib): (gnuplot): (itpp): (octave): (suitesparse-amd): (suitesparse-camd): (suitesparse-cholmod): (suitesparse-klu): (suitesparse-ldl): (suitesparse-mongoose): (suitesparse-spex): (suitesparse-spqr): (suitesparse-umfpack): (hypre): * gnu/packages/music.scm (lilypond): * gnu/packages/ocaml.scm (unison): (ocaml-bibtex2html): * gnu/packages/pdf.scm (extractpdfmark): * gnu/packages/photo.scm (enblend-enfuse): * gnu/packages/plotutils.scm (asymptote): * gnu/packages/python-xyz.scm (python-numpy-documentation): (python-ipython-documentation): (python-pypandoc): * gnu/packages/radio.scm (gnuradio): (libosmo-dsp): * gnu/packages/scheme.scm (mit-scheme): * gnu/packages/security-token.scm (yubico-piv-tool): * gnu/packages/sphinx.scm (python-sphinx): (python-sphinx-5): * gnu/packages/statistics.scm (r-with-tests): (r-spams): * gnu/packages/tex.scm (texlive-local-tree): Renamed from… (texlive-updmap.cfg): … this. Deprecate the latter. (texlive-biblatex-philosophy): (texlive-bropd): (texlive-fontsize): (texlive-poetrytex): (texlive-reverxii): (texlive-stix): (texlive-suftesi): (texlive-thucoursework): (texlive-ulqda): (texlive-yathesis): (texlive-makecell): (texlive-robotarm): (texlive-bbold): (texlive-babel-romansh): (texlive-polyglossia): (texlive-innerscript): (teximpatient): (texlive-xkeyval): (texlive-arabxetex): (texlive-blox): (texlive-ecgdraw): (texlive-gradientframe): (texlive-everyhook): (texlive-actuarialangle): (texlive-actuarialsymbol): (texlive-autopdf): (texlive-etaremune): (texlive-extract): (texlive-forarray): (texlive-graphicx-psmin): (texlive-ha-prosper): (texlive-namespc): (texlive-newspaper): (texlive-powerdot): (texlive-recipecard): (texlive-show2e): (texlive-tablists): (texlive-ted): (texlive-xargs): (texlive-xpeek): * gnu/packages/xdisorg.scm (xforms): * gnu/packages/algebra.scm (gap): * gnu/packages/cpp.scm (jthread): * guix/lint.scm (check-inputs-should-be-native): Rename `texlive-updmap.cfg' into `texlive-local-tree'. Change-Id: I129280807c418e57acbcbda399545ab27a9e0a33
2025-04-15Revert "doc: Emacs Packages: Remove outdated commentary on testing."Ludovic Courtès
This reverts commit b17268b53e9fb1b1ac2ad29fe7633b52744fee2f, which was meant for the ‘emacs-team’ branch as part of a patch series. Change-Id: I9d9b01924698aaf5bb6ac2c8472311976eeaacc6
2025-04-14doc: Emacs Packages: Remove outdated commentary on testing.Morgan Smith
* doc/contributing.texi (Emacs Packages): Removeoutdated commentary on testing. We now run the tests by default like is done in other build systems. Change-Id: I245a0a412615a1177fbd1b6e723fda3749f7e49f Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2025-02-19doc: Fix some misspellings.Efraim Flashner
Change-Id: I567aec7b1fac91234f46886c35affa6bd6e582d9
2025-01-04doc: contributing: Add guidance on reverting commits.Christopher Baines
Particularly to cover the case where things might need to happen with the build farms if changes are reverted. * doc/contributing.texi (Commit Access): Add guidance on reverting commits. Change-Id: Iba320b76b0927b693c75054b5473a50bdd77c7ee
2024-12-16doc: Document naming convention for work-in-progress branches.Maxim Cournoyer
* doc/contributing.texi (Managing Patches and Branches): Extend doc. Change-Id: I12253a81fe7c954734e68eba08eb5e8c8a434faa
2024-12-03doc: contributing: Remove --base=autoEkaitz Zarraga
* doc/contributing.texi(Sending a Patch Series): Remove --base=auto from examples Change-Id: Idd421f9d6b592d6a314edfaa66404dee4c1b2241
2024-12-03doc: Explain `git format-patch` revision formatEkaitz Zarraga
* doc/contributing.texi(Sending a Patch Series): Add a note about `git format-patch` revision format and link to git documentation. Change-Id: Ie08f85dc19e3804165fb184664b74e85a804d7c4
2024-12-01guix build: Add ‘--dependents’.Ludovic Courtès
* guix/scripts/build.scm (show-help, %options): Add ‘--dependents’. (dependents): New procedure. (options->things-to-build): Add ‘store’ parameter; honor ‘dependents’ option. [for-type]: Handle ‘dependents’ type. (options->derivations): Update call to ‘options->things-to-build’. * tests/guix-build.sh: Add test. * doc/guix.texi (Additional Build Options): Document ‘--dependents’. (Invoking guix refresh): Cross-reference it. * doc/contributing.texi (Submitting Patches): Mention it. Change-Id: I00b6d5831e1f1d35dc8b84a82605391d5a8f417c
2024-11-29doc: Add "Contributing to Guix's infrastructure".Ekaitz Zarraga
Use the "Call for contribution to the Guix infrastructure" by Ludovic Courtès to create a section in the documentation that describes how to contribute to the infrastructure. https://lists.gnu.org/archive/html/guix-devel/2024-05/msg00183.html * doc/contributing.texi (Contributing to Guix's infrastructure): New section. Change-Id: I3f3a99ad884110cc8323789e8c14bec1f7327e97
2024-11-24doc: Fix typos.Florian Pelz
* doc/contributing.texi (Commit Access): Use @xref when beginning a sentence. * doc/guix.texi (package Reference): Likewise. (Invoking guix gc): Add missing words. (Invoking guix pack): Likewise. (Specifying Channel Authorizations): Move period after closing parenthesis. (origin Reference)[git-fetch, git-fetch/lfs]: Add missing optional argument. [svn-reference]: Add missing ‘the’. Change-Id: I8a5e475e928200299117e55274847319eeda8bdb
2024-11-05doc: Explicitly mention --localstatedir and --sysconfdir configure flags.Arun Isaac
Prior to this commit, the terms localstatedir and sysconfdir were used without being defined earlier in this section. This commit clarifies that they are configure flags. * doc/contributing.texi (Building from Git): Explicitly mention --localstatedir and --sysconfdir configure flags. Change-Id: I3e6edbbc1f2a342196e732e14257dbdf9a3f4303
2024-11-03doc: Promote “Teams” section.Ludovic Courtès
Suggested by Simon Tournier <zimon.toutoune@gmail.com>. * doc/contributing.texi (Teams): Move from subsection of “Submitting Patches” to section of “Contributing”. Reviewed-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Change-Id: Id21be29380fc981e74a5025b1467eebde8566726
2024-11-03doc: Add “Making Decisions” section.Ludovic Courtès
Suggested by Simon Tournier <zimon.toutoune@gmail.com>. * doc/contributing.texi (Making Decisions): New section, with paragraphs moved from… (Commit Access): … here. Cross-reference it. (Teams): Likewise. Reviewed-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Change-Id: Ib276242e0ec7598a1b60dacdde8647bd3d3b85d3
2024-10-31doc: Fix markup.Florian Pelz
* doc/contributing.texi (Source Tree Structure, Submitting Patches, Translating Guix): Write @command instead of @code when invoking guix. (Submitting Patches): Write @code instead of @command for a field name. * doc/guix-cookbook.texi (A ``Hello World'' package): Use @xref at the beginning of a sentence. (Auto-Login to a Specific TTY): Remove a space before @pxref. (Basic setup with manifests): Write @ref instead of (@pxref) after ``see''. Change-Id: I1ced2ebc4062b3a80878a7e0eea8f7a3d4baf7da
2024-10-14doc: Define the purpose, membership, and creation of teams.Ludovic Courtès
* doc/contributing.texi (Teams): Define the purpose of teams; provide example; clarify membership and team creation. (Reviewing the Work of Others): Link to “Teams”. Change-Id: I5d75f69bc4653eb9da9c1d1f920718238ea83b9d
generated by cgit v1.3 (git 2.53.0) at 2026-05-28 07:43:31 +0000