summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
Commit message (Collapse)AuthorAge
* doc: contributing: Use proper subsections.(2022-11-01
| | | | | | | | * 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>
* doc: contributing: Expand "Sending a Patch Series".(2022-10-28
| | | | | | | * doc/contributing.texi: Expand on sending patches and using git send-email. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
* build-system: Add pyproject-build-system.Lars-Dominik Braun2022-10-27
| | | | | | | | | | | | | | | | | | | 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>
* doc: Add git send-email tip in 'Submitting Patches' section.Maxim Cournoyer2022-10-07
| | | | | | * 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.
* etc: teams: Add scope support.Mathieu Othacehe2022-09-25
| | | | | | | | | | | | | | | | 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.
* doc: Add more info about commits signature local verification.Andrew Tropin2022-09-05
| | | | | * doc/contributing.texi (Commit Access): Add more info about commits signature local verification.
* etc: Add tempel snippets.Nicolas Graves2022-08-30
| | | | | | | | | | | | | * 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>
* doc: Fix the example of "Run `make` automatically"Rostislav Svoboda2022-07-18
| | | | | | | * doc/contributing.texi (Running Guix Before It Is Installed): add missing command separator '--'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* monad-repl: Add "build", "lower", and "verbosity" commands.Ludovic Courtès2022-07-15
| | | | | | | | | | | | | | | | 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'.
* doc: Prefer "guix show" over "guix package --show".Ludovic Courtès2022-07-13
| | | | | * doc/contributing.texi (Synopses and Descriptions): Use "guix show" instead of "guix package --show".
* doc: Fix cross-reference to Git Info manual.Maxim Cournoyer2022-07-11
| | | | | | | | 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.
* doc: Document the documentation process.jgart2022-07-07
| | | | | | | | | | | * 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>
* doc: Fix typos.Tobias Geerinckx-Rice2022-05-22
| | | | | | | * 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.
* import: Add Elm importer.Philip McGrath2022-05-22
| | | | | | | | | | | * 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>
* guix: Add elm-build-system.Philip McGrath2022-05-22
| | | | | | | | | | | | | | * 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>
* doc: Document inclusion requirements for new translations.Julien Lepiller2022-04-02
| | | | | * doc/contributing.texi (Translating Guix)[Conditions for Inclusion]: New section.
* doc: Move build commands to @example for clarity.Ludovic Courtès2022-02-15
| | | | | | * doc/contributing.texi (Building from Git): Tweak so that all the commands appear in @example boxes. Show --localstatedir=/var instead of --localstatedir=@var{directory}.
* doc: Add a rule of thumb to guide enabling new committers.base-for-series-11226base-for-series-11225base-for-series-11224base-for-series-11223base-for-series-11221base-for-series-11219base-for-series-11218base-for-series-11217base-for-series-11216base-for-series-11215base-for-series-11214base-for-series-11213base-for-series-11212base-for-series-11211base-for-series-11210base-for-series-11209base-for-series-11208base-for-series-11206base-for-series-11205Maxim 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.
generated by cgit v1.2.3 (git 2.45.0) at 2024-06-12 03:45:08 +0000