summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
AgeCommit message (Expand)Author
2023-07-18gnu: Deprecate `texlive-tiny'....At this point, there are three equivalent TeX Live sub-systems: texlive-scheme-basic, texlive-tiny, and (texlive-updmap.cfg). It is confusing to keep so many around. * doc/contributing.texi (Submitting Patches): Remove reference to TEXLIVE-TINY. * gnu/packages/algebra.scm (pari-gp)[native-inputs]: (giac)[native-inputs]: * gnu/packages/chez.scm (chez-sockets)[native-inputs]: * gnu/packages/engineering.scm (fastcap)[native-inputs]: * gnu/packages/gettext.scm (po4a)[native-inputs]: * gnu/packages/maths.scm (cddlib)[native-inputs]: (gnuplot)[native-inputs]: (itpp)[native-inputs]: * gnu/packages/ocaml.scm (unison)[native-inputs]: * gnu/packages/pdf.scm (extractpdfmark)[native-inputs]: * gnu/packages/photo.scm (enblend-enfuse): Replace TEXLIVE-TINY with a call to TEXLIVE-UPDMAP.CFG. * gnu/packages/radio.scm (gnuradio)[native-inputs]: Remove unnecessary TEXLIVE-TINY. * gnu/packages/tex.scm (texlive-tiny): Deprecate it in favor of TEXLIVE-SCHEME-BASIC. (texlive-makecmds)[native-inputs]: Replace TEXLIVE-TINY with a call to TEXLIVE-UPDMAP.CFG. * guix/lint.scm (check-inputs-should-be-native): Check only for "texlive-updmap.cfg" input name. Nicolas Goaziou
2023-06-12doc: Move and rewrite the branching strategy....Move away from using staging and core-updates, and make the strategy independant of branch names. Keep the 300 dependent threshold for changes to master, as I don't have any specific reason to change this. Most importantly, require using guix-patches issues to coordinate merging of the branches, as I think that'll address the key issues that have shown up recently where it's been unclear which branch should be merged next. * doc/contributing.texi (Submitting Patches): Move the branching strategy to a new Managing Patches and Branches section. (Managing Patches and Branches): New section. (Commit Policy): Simplify through referencing the new Managing Patches and Branches section. Signed-off-by: Christopher Baines <mail@cbaines.net> Christopher Baines
2023-06-08doc: Use the term "Procedure" for definitions....In an effort to homogenize things, commit 3c40dfe2851dd4ef48d2711f9f3531c06afbe1f2 replaced: @deffn {Scheme Procedure} with: @defun However, the latter prints "Function" when all existing material about Scheme uses the term "procedure". Thus, for consistency, this commit switches to: @deffn {Procedure} * doc/guix.texi, doc/contributing.texi: Use "@deffn {Procedure}" consistently rather than "@defun" or similar. Ludovic Courtès
2023-05-24doc: contributing.texi: Specify recipient via equal sign in 'git send-email -......The documentation for git send-email recommends the use of an equal sign when specifying a recipient with the --to option. [1] Adjusts the reference manual accordingly. [1] https://git-scm.com/docs/git-send-email * doc (contributing.texi): Specify recipient via equal sign in 'git send-email --to'. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Felix Lechner
2023-05-07Revert "doc: Update all menus."...This reverts commit 9719d7d2b0733c57e30bff3180ff0fa25c34c66f. It breaks Guix pull, building the 'guix-manual' for reasons that currently escape me. Maxim Cournoyer
2023-05-07doc: Update all menus....Automated via 'M-x texinfo-all-menus-update' in Emacs, and dropping the *Contributing menu removal, which is erroneously removed because defined in a different Texinfo file. * doc/guix.texi: Update all menus. * doc/contributing.texi (Submitting Patches): Likewise. Maxim Cournoyer
2023-05-07doc: Add some information/recommendation regarding --sysconfdir....* doc/contributing.texi (Building from Git): Mention sysconfdir along localstatedir. * doc/guix.texi (Requirements): Likewise. Maxim Cournoyer
2023-05-01doc: Simplify contributing section by automating git configuration....Fixes <https://issues.guix.gnu.org/58813>. No longer suggests to splice the output of etc/teams.scm commands into the 'git send-email' command line; this is now transparently handled by the Git configuration, which is also automatic. * doc/contributing.texi (Configuring Git): Streamline section, now automated via Automake. (Sending a Patch Series): Do not specify options configured as default by the above. Prefer long option names, for readability. (Teams): Rewrite the examples to use --header-cmd. (Commit Access): Refer to the Configuring Git section instead of detailing manual steps. Maxim Cournoyer
2023-04-30doc: Add --sysconfdir=/etc to the recommended ./configure....* doc/contributing.texi (Building from Git): Add --sysconfdir=/etc to the recommended ./configure invocation. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Josselin Poiret
2023-04-03doc: Add a reference to a page explaining consensus decision making....This is to make explicit something which until now had always been implicit. * doc/contributing.texi (Commit Access): Mention that committers are expected to employ consensus decision making. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Maxim Cournoyer
2023-03-23doc: Mention Python 2 packages should not be added anymore....* doc/contributing.texi (Python Modules): Mention Python 2 packages should not be added anymore. Maxim Cournoyer
2023-03-10doc: Sending-a-Patch-Series: Fix URL....* doc/contributing.texi (Sending a Patch Series): Fix URL for issue tracker. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Hugo Buddelmeijer
2023-03-05doc: Give advice to contributors about communicating with reviewers....* doc/contributing.texi (Submitting Patches): Give advice. Leo Famulari
2023-01-11doc: contributing: Note '-v REVISION' bug in 'git send-email'....* doc/contributing.texi ("Submitting Patches")["Sending a Patch Series"]: Note that a bug in 'git send-email' means '-v REVISION' (with a space) will not work. Signed-off-by: Christopher Baines <mail@cbaines.net> (
2023-01-11doc: contributing: Tweak the Commit Policy....Add more examples of when it can be appropriate to push changes without review, as I think this can be appropriate in the case of trivial changes (as mentioned before), but also non-trivial fixes. No longer suggest pushing simple new packages or package upgrades (that don't cause lots of rebuilds) without sending to guix-patches. Now there's some automation for testing changes sent to guix-patches, sending changes there before pushing can mean that more rigorous testing takes place and help speed up substitutes becoming available. This is true, even if no human review takes place. Only suggest waiting one week for review for simpler changes, wait two weeks for more significant changes. Also, reorder some of the information in this section so it's grouped together better. * doc/contributing.texi (Commit Policy): Tweak. Signed-off-by: Christopher Baines <mail@cbaines.net> Christopher Baines
2022-12-18doc: Fix typo....* doc/contributing.texi (Sending a Patch Series): Fix e-mail address of <guix-patches@gnu.org>. Reported by Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>. Tobias Geerinckx-Rice
2022-12-02doc: Recommend 'match-record'....* doc/contributing.texi (Data Types and Pattern Matching): Recommend 'match-record'. Ludovic Courtès
2022-11-01doc: contributing: Use proper subsections....* doc/contributing.texi ("Submitting Patches") ["Sending a Patch Series", "Teams"]: Convert to numbered subsections. Add nodes. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com> (
2022-10-28doc: contributing: Expand "Sending a Patch Series"....* doc/contributing.texi: Expand on sending patches and using git send-email. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com> (
2022-10-27build-system: Add pyproject-build-system....This is an experimental build system based on python-build-system that implements PEP 517-compliant builds. * doc/guix.texi (Build Systems): Add pyproject-build-system section. * doc/contributing.texi (Python Modules): Mention pyproject.toml and the PYTHON-TOOLCHAIN package, as well as differences to python-build-system. * guix/build-system/pyproject.scm, guix/build/pyproject-build-system.scm, gnu/packages/aux-files/python/sanity-check-next.py, gnu/packages/python-commencement.scm: New files. * Makefile.am (MODULES): Register the new build systems. * gnu/local.mk (GNU_SYSTEM_MODULES): Add python-commencement.scm. * gnu/packages/python.scm (python-sans-pip, python-sans-pip-wrapper): New variables. Co-authored-by: Marius Bakke <marius@gnu.org> Lars-Dominik Braun
2022-10-07doc: Add git send-email tip in 'Submitting Patches' section....* doc/contributing.texi (Submitting Patches): Add a tip detailing how to prefix the subject line with the branch name the change should be installed to. Maxim Cournoyer
2022-09-25etc: teams: Add scope support....Add a scope list to each team. This list defines all the files and directories that are mentored by the team. Also add a cc-members command that takes two Git revision strings as input, add returns the members that should be CC'ed given the files impacted between the two revisions. * etc/teams.scm.in (<team>)[scope]: New field. (team, list-teams): Adapt those procedures. (find-team-by-scope, diff-revisions): New procedures. (main): Add a "cc-members" command. * doc/contributing.texi ("Teams"): Document it. ("Sending a Patch Series"): Adapt it. Mathieu Othacehe
2022-09-05doc: Add more info about commits signature local verification....* doc/contributing.texi (Commit Access): Add more info about commits signature local verification. Andrew Tropin
2022-08-30etc: Add tempel snippets....* etc/snippets/tempel/scheme-mode: New file. * etc/snippets/tempel/text-mode: New file. * etc/snippets/scheme-mode: Moved from here... * etc/snippets/yas/scheme-mode: ... to here. * etc/snippets/text-mode: Moved from here... * etc/snippets/yas/text-mode: ... to here. * doc/contributing.texi ("The Perfect Setup"): Adjust yasnippet setup accordingly. Add tempel setup. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com> Nicolas Graves
2022-07-18doc: Fix the example of "Run `make` automatically"...* doc/contributing.texi (Running Guix Before It Is Installed): add missing command separator '--'. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Rostislav Svoboda
2022-07-15monad-repl: Add "build", "lower", and "verbosity" commands....Fixes <https://issues.guix.gnu.org/56114>. Reported by Maxime Devos <maximedevos@telenet.be>. * guix/monad-repl.scm (%build-verbosity): New variable. (evaluate/print-with-store): New procedure. (run-in-store): Rewrite in terms of 'evaluate/print-with-store'. (verbosity, lower, build): New meta-commands. * doc/guix.texi (Using Guix Interactively): New node. (The Store Monad): Link to it. (Invoking guix repl): Likewise. * doc/contributing.texi (Running Guix Before It Is Installed): Refer to it. (The Perfect Setup): Suggest 'guix install' rather than 'guix package -i'. Ludovic Courtès
2022-07-13doc: Prefer "guix show" over "guix package --show"....* doc/contributing.texi (Synopses and Descriptions): Use "guix show" instead of "guix package --show". Ludovic Courtès
2022-07-11doc: Fix cross-reference to Git Info manual....Partially fixes <https://issues.guix.gnu.org/55821>. Partially because our git package doesn't yet include the documentation. This change will need to go to core-updates. * doc/contributing.texi (Submitting Patches): Adjust the node name. Maxim Cournoyer
2022-07-07doc: Document the documentation process....* doc/contributing.texi (Contributing): Add Writing Documentation section. Co-authored-by: Julien Lepiller <julien@lepiller.eu> Co-authored-by: Matt Trzcinski <matt@excalamus.com> Co-authored-by: Fabio Natali <me@fabionatali.com> Co-authored-by: Gabor Boskovits <boskovits@gmail.com> Co-authored-by: Luis Felipe <luis.felipe.la@protonmail.com> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> jgart
2022-05-22doc: Fix typos....* doc/guix.texi (Guix Services): Fix ‘coresponding’ typo. (Using cross-compilation): Fix ‘mecanism’ typo. (Desktop Services): Fix ‘superceeded’ typo. * doc/contributing.texi (Translating Guix): Fix ‘everytime’ typo. Tobias Geerinckx-Rice
2022-05-22import: Add Elm importer....* guix/import/elm.scm, guix/scripts/import/elm.scm: New files. * Makefile.am (MODULES): Add them. * guix/scripts/import.scm (importers): Add "elm". * doc/guix.texi (Invoking guix import): Document Elm importer. * doc/contributing.texi (Elm Packages): Mention it. * tests/elm.scm ("(guix import elm)"): New test group. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Philip McGrath
2022-05-22guix: Add elm-build-system....* gnu/packages/patches/elm-offline-package-registry.patch: New file. * gnu/local.mk (dist_patch_DATA): Add it. * gnu/packages/elm.scm (elm): Use it. * guix/build-system/elm.scm, guix/build/elm-build-system.scm, tests/elm.scm: New files. * Makefile.scm (MODULES, SCM_TESTS): Add them. * doc/guix.texi (Build Systems): Document 'elm-build-system'. * doc/contributing.texi (Elm Packages): New section. Document naming conventions and utilities. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Philip McGrath
2022-04-02doc: Document inclusion requirements for new translations....* doc/contributing.texi (Translating Guix)[Conditions for Inclusion]: New section. Julien Lepiller
2022-02-15doc: Move build commands to @example for clarity....* doc/contributing.texi (Building from Git): Tweak so that all the commands appear in @example boxes. Show --localstatedir=/var instead of --localstatedir=@var{directory}. Ludovic Courtès
2022-01-31doc: Add a rule of thumb to guide enabling new committers....* doc/contributing.texi (Commit Access): Introduce a new rule of thumb to determine if a contributor should be considered to become a committer. Maxim Cournoyer
2022-01-28doc: Mention how to remedy "source file ... newer than compiled error"....* 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> Guix Together
2022-01-28doc: Explain the use of make clean-go when an ABI mismatch occurs....* 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> Guix Together
2022-01-10style: Add '--styling' option....* 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. Ludovic Courtès
2021-12-20doc: Remove extra closing paren....* doc/contributing.texi (Emacs Packages): Remove extra paren in example. Ludovic Courtès
2021-12-02doc: Give more details about generating patches with base commit information....* doc/contributing.texi (Submitting Patches): Talk more about '--base'. Leo Famulari
2021-11-17doc: Improve wording for param spec of `./configure`....* 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> Rostislav Svoboda
2021-10-25Add 'guix shell'....* 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". Ludovic Courtès
2021-10-14doc: Fix typo....* doc/contributing.texi (Configuring Git): s/respository/repository/ Marius Bakke
2021-10-04maint: Improve default diff hunk header detection....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> Sarah Morgensen
2021-09-22doc: Add item to "Submitting Patches" section....* doc/contributing.texi (Submitting Patches): Add item about 'git-format-patch --base'. Signed-off-by: Ludovic Courtès <ludo@gnu.org> zimoun
2021-07-05doc: Change Debbugs usertags user to "guix"....* 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>. Chris Marusich
2021-06-23doc: Document the use of Debbugs usertags....* 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. Chris Marusich
2021-06-18doc: Clarify Git commit signing; fix typo....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. Ludovic Courtès
2021-06-18doc: Explain more reasons for commit revocation....* doc/contributing.texi (Commit Revocation): Expound. Ludovic Courtès
2021-06-18doc: Add "Addressing Issues" section....* doc/contributing.texi (Addressing Issues): New section. Co-authored-by: Christopher Baines <mail@cbaines.net> Ludovic Courtès