summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
Commit message (Collapse)AuthorAgeFilesLines
...
* doc: Add new 'Circular Module Dependencies' section.Maxim Cournoyer2023-09-251-0/+56
| | | | | | | | | | | | | | | * doc/contributing.texi (Circular Module Dependencies): New subsection. Series-version: 2 Series-to: 65860@debbugs.gnu.org Patch-cc: mhw@netris.org Cover-letter: Resolve a circular module dependencies in embedded modules This series is the culmination of at least a day of effort tracking down the source of a module dependency cycle (!). The last commit adds some guidelines in the hope to avoid a repeat (perhaps 'lint' could be taught to automate these checks). END
* doc: contributing: Clarify generating the pre-inst-env script.Efraim Flashner2023-09-221-6/+5
| | | | | | | | Lack of clarity reported by lrustland on IRC. * doc/contributing.texi (Running Guix Before It Is Installed): Refer to the Building from Git section when giving instructions for generating the pre-inst-env script.
* maint: Support `guix shell' in Guix's git archive with manifest.scm.Janneke Nieuwenhuizen2023-09-181-0/+6
| | | | | | * manifest.scm: New file. * Makefile.am (EXTRA_DIST): Add it. * doc/contributing.texi (Building from Git): Mention using it.
* .dir-locals.el: Update bug-reference configuration and document it.Maxim Cournoyer2023-09-171-0/+64
| | | | | | | | (nil) <bug-reference-url-format>: Update URL. Add comment. * doc/contributing.texi (The Perfect Setup): New "Viewing bugs within Emacs" subsection. Co-authored-by: Brian Cully <bjc@spork.org>
* .dir-locals: Streamline Geiser configuration.Maxim Cournoyer2023-09-061-9/+4
| | | | | | | | | | | | | Geiser now has support locating the project root and adding it to the load path without external help; leverage it. * .dir-locals.el [nil]: Remove obsolete Geiser configuration. Set the geiser-repl-per-project-p variable to t. * doc/contributing.texi (The Perfect Setup): No longer mention explicitly setting the geiser-guile-load-path; instead mention the effect of the .dir-locals.el file. Reported-by: Wolf <wolf@wolfsden.cz>
* doc: Document mumi command-line interface.Arun Isaac2023-09-051-4/+94
| | | | | | | | | * doc/contributing.texi (Debbugs User Interfaces)[Command-line interface]: New subsubsection. Update menus. * doc/guix.texi: Bump copyright year. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Modified-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* doc: contributing: Mention the expected branch merge request format.Maxim Cournoyer2023-08-161-2/+13
| | | | | * doc/contributing.texi (Managing Patches and Branches): Mention the expected branch merge request format.
* gnu: Deprecate `texlive-tiny'.Nicolas Goaziou2023-07-181-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* doc: Move and rewrite the branching strategy.Christopher Baines2023-06-121-71/+73
| | | | | | | | | | | | | | | | | | | | 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>
* doc: Use the term "Procedure" for definitions.Ludovic Courtès2023-06-081-6/+6
| | | | | | | | | | | | | | | | | | | | | 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.
* doc: contributing.texi: Specify recipient via equal sign in 'git send-email ↵Felix Lechner2023-05-241-3/+3
| | | | | | | | | | | | | | | --to'. 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>
* Revert "doc: Update all menus."Maxim Cournoyer2023-05-071-6/+0
| | | | | This reverts commit 9719d7d2b0733c57e30bff3180ff0fa25c34c66f. It breaks Guix pull, building the 'guix-manual' for reasons that currently escape me.
* doc: Update all menus.Maxim Cournoyer2023-05-071-0/+6
| | | | | | | | | 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.
* doc: Add some information/recommendation regarding --sysconfdir.Maxim Cournoyer2023-05-071-3/+5
| | | | | | * doc/contributing.texi (Building from Git): Mention sysconfdir along localstatedir. * doc/guix.texi (Requirements): Likewise.
* doc: Simplify contributing section by automating git configuration.Maxim Cournoyer2023-05-011-69/+35
| | | | | | | | | | | | | | | 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.
* doc: Add --sysconfdir=/etc to the recommended ./configure.Josselin Poiret2023-04-301-1/+1
| | | | | | | * doc/contributing.texi (Building from Git): Add --sysconfdir=/etc to the recommended ./configure invocation. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Add a reference to a page explaining consensus decision making.Maxim Cournoyer2023-04-031-1/+6
| | | | | | | | | 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>
* doc: Mention Python 2 packages should not be added anymore.Maxim Cournoyer2023-03-231-3/+2
| | | | | * doc/contributing.texi (Python Modules): Mention Python 2 packages should not be added anymore.
* doc: Sending-a-Patch-Series: Fix URL.Hugo Buddelmeijer2023-03-101-1/+1
| | | | | | * doc/contributing.texi (Sending a Patch Series): Fix URL for issue tracker. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Give advice to contributors about communicating with reviewers.Leo Famulari2023-03-051-0/+10
| | | | * doc/contributing.texi (Submitting Patches): Give advice.
* doc: contributing: Note '-v REVISION' bug in 'git send-email'.(2023-01-111-1/+7
| | | | | | | | * 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>
* doc: contributing: Tweak the Commit Policy.Christopher Baines2023-01-111-23/+19
| | | | | | | | | | | | | | | | | | | | | | | 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>
* doc: Fix typo.Tobias Geerinckx-Rice2022-12-181-1/+1
| | | | | | | * doc/contributing.texi (Sending a Patch Series): Fix e-mail address of <guix-patches@gnu.org>. Reported by Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>.
* doc: Recommend 'match-record'.Ludovic Courtès2022-12-021-1/+6
| | | | | * doc/contributing.texi (Data Types and Pattern Matching): Recommend 'match-record'.
* doc: contributing: Use proper subsections.(2022-11-011-4/+4
| | | | | | | | * 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-281-37/+136
| | | | | | | * 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-271-8/+28
| | | | | | | | | | | | | | | | | | | 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-071-6/+19
| | | | | | * 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-251-0/+41
| | | | | | | | | | | | | | | | 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-051-3/+12
| | | | | * doc/contributing.texi (Commit Access): Add more info about commits signature local verification.
* etc: Add tempel snippets.Nicolas Graves2022-08-301-4/+14
| | | | | | | | | | | | | * 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-181-2/+2
| | | | | | | * 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-151-3/+2
| | | | | | | | | | | | | | | | 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-131-1/+1
| | | | | * 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-111-5/+5
| | | | | | | | 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-071-0/+42
| | | | | | | | | | | * 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-221-1/+1
| | | | | | | * 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-221-2/+2
| | | | | | | | | | | * 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-221-0/+82
| | | | | | | | | | | | | | * 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-021-0/+22
| | | | | * doc/contributing.texi (Translating Guix)[Conditions for Inclusion]: New section.
* doc: Move build commands to @example for clarity.Ludovic Courtès2022-02-151-13/+32
| | | | | | * 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.Maxim Cournoyer2022-01-311-3/+8
| | | | | * 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-281-0/+18
| | | | | | | | | | | | * 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-281-0/+12
| | | | | | | | | | | * 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-101-10/+8
| | | | | | | | | | | | | | | | | | | * 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-201-1/+1
| | | | * doc/contributing.texi (Emacs Packages): Remove extra paren in example.
* doc: Give more details about generating patches with base commit information.Leo Famulari2021-12-021-2/+5
| | | | * doc/contributing.texi (Submitting Patches): Talk more about '--base'.
* doc: Improve wording for param spec of `./configure`.Rostislav Svoboda2021-11-171-6/+6
| | | | | | | * 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-251-4/+4
| | | | | | | | | | | | | | | | | | | | | | | * 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-141-1/+1
| | | | * doc/contributing.texi (Configuring Git): s/respository/repository/
generated by cgit v1.2.3 (git 2.47.1) at 2025-01-18 12:02:04 +0000