summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
AgeCommit message (Collapse)Author
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
2024-10-12doc: Add “Deprecation Policy” section.Ludovic Courtès
* doc/contributing.texi (Deprecation Policy): New node. (Commit Access): Link to ‘package-removal-policy’. Change-Id: I5d095559920a3d9b791b5d919aab4e2f2a0c2dee
2024-09-01doc: Committers are people.Tobias Geerinckx-Rice
* doc/contributing.texi (Commit Access): Use ‘who’. Change-Id: I88304640f8f184f7ec0caae5bb862c7f170c0d79
2024-09-01doc: Add newlines.Tobias Geerinckx-Rice
* doc/contributing.texi (Commit Access): Split one trademark Guix megagraph™ into three of your human paragraphs. No other change. Change-Id: Ifd2a9166b1dfe1a22dcd0811044a408325cc22cb
2024-06-26doc: Introduce mumi before referring to it.Ludovic Courtès
* doc/contributing.texi (Debbugs User Interfaces): Introduce mumi in the body of the text rather than a footnote since the “Command-Line Interface” section assumes it has already been introduced. (Command-Line Interface, Emacs Interface): Capitalize titles. Change-Id: I0e87cd48b6158582016734afe71c716c548c1639
2024-06-24doc: Add message for common error about make check-system.Richard Sent
* doc/contributing.texi (Running the Test Suite): Mention that make clean-go may need to be run before running make check-system when previous builds were run with different work trees. Change-Id: I4b68d3a05f1425505816db969284487d725840d6 Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Fixes: https://issues.guix.gnu.org/47573.
2024-06-24doc: contributing: Mention 'guix git authenticate'.Simon Tournier
Follow up of 73b3f941d7d911a1b2bb2bf77d37cb3a12ed4291. * doc/contributing.texi (Applying for Commit Access): Update accordingly with the removal of 'make authenticate'. Change-Id: Id945c484f6265c76d4eb803369a7fbd9f797434f Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-06-24doc: Fix Reviewed-by format.Tomas Volf
The documentation does not have a space between `e' and `<', which is not how people use it, as can be seen from git log. So adjust the format to match the reality. * doc/contributing.texi (Reviewing the Work of Others): Fix format for Reviewed-by. Change-Id: Ib863536db72b885cf34927323cb4ebc52a8db2ed Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-06-12doc: Refer to mumi send-email in Submitting Patches.Arun Isaac
* doc/contributing.texi (Submitting Patches): Refer to mumi send-email. Change-Id: I009cdc306220ef63e6641fac69d3453ab169bfa2
2024-06-12doc: Add mumi CLI concept index entries.Arun Isaac
* doc/contributing.texi (Debbugs User Interfaces)[Command-line interface]: Add mumi CLI concept index entries. Change-Id: Ic2e67226c18e87a7360b938476a662aae76dd58e
2024-06-12doc: Document mumi am, compose and www subcommands.Arun Isaac
* doc/contributing.texi (Debbugs User Interfaces)[Command-line interface]: Document mumi am, compose and www subcommands. * doc/guix.texi: Bump copyright year. Change-Id: I28bde9454ad35115ed60fe4d6ffa35fad599b2d1
2024-05-25configure.ac: Set default value for the 'prefix' variable.Maxim Cournoyer
The Guix standard configuration uses a localstatedir of /var and a sysconfdir of /etc. To ease things for everyone, make the default values match that standard expected configuration. See <https://lists.gnu.org/archive/html/guix-devel/2024-05/msg00003.html> for a related discussion. * configure.ac: Default $prefix to '' unless already set. * doc/contributing.texi (Building from Git): Streamline doc. * doc/guix-cookbook.texi (Guix environment via direnv): Likewise. Reviewed-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I23cd12b58a842d246fbc9fdc740311c573eb0212
2024-05-25maint: Suggest ‘guix git authenticate’ for initial authentication.Ludovic Courtès
The previous recommendation, running ‘make authenticate’, was insecure because it led users to run code from the very repository they want to authenticate: https://lists.gnu.org/archive/html/guix-devel/2024-04/msg00252.html * Makefile.am (commit_v1_0_0, channel_intro_commit) (channel_intro_signer, GUIX_GIT_KEYRING, authenticate): Remove. * Makefile.am (.git/hooks/%): New target, generalization of previous ‘.git/hooks/pre-push’ target. (nodist_noinst_DATA): Add ‘.git/hooks/post-merge’. * doc/contributing.texi (Building from Git): Suggest ‘guix git authenticate’ instead of ‘make authenticate’. * etc/git/post-merge: New file. * etc/git/pre-push: Run ‘guix git authenticate’ instead of ‘make authenticate’. Reviewed-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Reported-by: Skyler Ferris <skyvine@protonmail.com> Change-Id: Ia415aa8375013d0dd095e891116f6ce841d93efd
2024-05-22doc: Make changes to the handling of branches.Christopher Baines
Require that you create a "Request to merge" issue when you create a branch, rather than when you wish to merge it. This should help avoid this step being missed. Also, add information on how to manage these branches: 1. Suggest creating the branch from patches, rather than having a stateful branch, since this should help to reduce complexity and avoid merges. 2. Require that branches don't have unnecessary changes, since this increases the risks of conflicts with other branches. 3. Suggest that the branch not be stateful, and it's just a combination of patches. 4. Suggest avoiding merges since these create a more complicated Git history. 5. Suggest that the branch be up to date before merging, as this helps avoid the combination of master plus the branch differing significantly from the branch alone. 6. Document how to manage branches without commit access. Finally, require that the branch be deleted once they're merged. This prepares for the branch being created again. * doc/contributing.texi (Managing Patches and Branches): Make changes to the handling of branches. Change-Id: Ib9419c6df94f485475bd6f147e82ea254e76cec2
2024-04-26doc: contributing: Move localstatedir instructions.Florian Pelz
* doc/contributing.texi (Requirements): Move localstatedir ... (Building from Git): ... here. Change-Id: I860bb7a9e6aea12881469c667496364248293c31
2024-04-26doc: contributing: Suggest building from Git.Florian Pelz
* doc/contributing.texi (Requirements): Explain the purpose of this section. Refer regular contributors to Building from Git. Change-Id: I731af4ac8e78b053b96a3b683528964223ab740b
2024-04-06doc: Move "Running the Test Suite" after "Building from Git".Matthew Trzcinski
* doc/contributing.texi (doc/guix.texi): Move "Running the Test Suite" after "Building from Git". Link: <https://lists.gnu.org/archive/html/guix-devel/2024-03/msg00023.html> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-04-06doc: Move "Requirements" before "Building from Git"Matthew Trzcinski
* doc/contributing.texi (doc/guix.texi): Move "Requirements" before "Building from Git". Link: <https://lists.gnu.org/archive/html/guix-devel/2024-03/msg00023.html> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-04-05doc: Explain to run bootstrap after Automake errors.Florian Pelz
Fixes <https://issues.guix.gnu.org/70140>. Suggested by Rostislav Svoboda <rostislav.svoboda@gmail.com>. * doc/contributing.texi (Building from Git): Explain. * doc/guix.texi: Update copyright year. Change-Id: I0cedc60f9ece3ec78df60df54ffeacff545bfc63
2024-03-21doc: Add “Source Tree Structure” section.Ludovic Courtès
* doc/contributing.texi (Source Tree Structure): New node. * doc/guix.texi (Programming Interface): Add cross-reference. Change-Id: I141a1f4d806ae5f72c7a246e18c14dc63056a607
generated by cgit v1.2.3 (git 2.50.1) at 2025-08-03 03:02:23 +0000