summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
Commit message (Collapse)AuthorAgeFilesLines
* doc: contributing: Add guidance on reverting commits.Christopher Baines2025-01-041-0/+14
| | | | | | | | | 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
* doc: Document naming convention for work-in-progress branches.Maxim Cournoyer2024-12-161-0/+11
| | | | | | * doc/contributing.texi (Managing Patches and Branches): Extend doc. Change-Id: I12253a81fe7c954734e68eba08eb5e8c8a434faa
* doc: contributing: Remove --base=autoEkaitz Zarraga2024-12-031-2/+2
| | | | | | | * doc/contributing.texi(Sending a Patch Series): Remove --base=auto from examples Change-Id: Idd421f9d6b592d6a314edfaa66404dee4c1b2241
* doc: Explain `git format-patch` revision formatEkaitz Zarraga2024-12-031-0/+12
| | | | | | | * doc/contributing.texi(Sending a Patch Series): Add a note about `git format-patch` revision format and link to git documentation. Change-Id: Ie08f85dc19e3804165fb184664b74e85a804d7c4
* guix build: Add ‘--dependents’.Ludovic Courtès2024-12-011-1/+3
| | | | | | | | | | | | | | | * 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
* doc: Add "Contributing to Guix's infrastructure".Ekaitz Zarraga2024-11-291-0/+202
| | | | | | | | | | | | | 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
* doc: Fix typos.Florian Pelz2024-11-241-1/+1
| | | | | | | | | | | | | * 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
* doc: Explicitly mention --localstatedir and --sysconfdir configure flags.Arun Isaac2024-11-051-6/+7
| | | | | | | | | | | 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
* doc: Promote “Teams” section.Ludovic Courtès2024-11-031-78/+78
| | | | | | | | | | 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
* doc: Add “Making Decisions” section.Ludovic Courtès2024-11-031-17/+28
| | | | | | | | | | | | 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
* doc: Fix markup.Florian Pelz2024-10-311-8/+9
| | | | | | | | | | | | * 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
* doc: Define the purpose, membership, and creation of teams.Ludovic Courtès2024-10-141-10/+53
| | | | | | | | * 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
* doc: Add “Deprecation Policy” section.Ludovic Courtès2024-10-121-3/+196
| | | | | | | * doc/contributing.texi (Deprecation Policy): New node. (Commit Access): Link to ‘package-removal-policy’. Change-Id: I5d095559920a3d9b791b5d919aab4e2f2a0c2dee
* doc: Committers are people.Tobias Geerinckx-Rice2024-09-011-1/+1
| | | | | | * doc/contributing.texi (Commit Access): Use ‘who’. Change-Id: I88304640f8f184f7ec0caae5bb862c7f170c0d79
* doc: Add newlines.Tobias Geerinckx-Rice2024-09-011-8/+11
| | | | | | | * doc/contributing.texi (Commit Access): Split one trademark Guix megagraph™ into three of your human paragraphs. No other change. Change-Id: Ifd2a9166b1dfe1a22dcd0811044a408325cc22cb
* doc: Introduce mumi before referring to it.Ludovic Courtès2024-06-261-9/+10
| | | | | | | | | * 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
* doc: Add message for common error about make check-system.Richard Sent2024-06-241-0/+14
| | | | | | | | | | * 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.
* doc: contributing: Mention 'guix git authenticate'.Simon Tournier2024-06-241-1/+4
| | | | | | | | | | 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>
* doc: Fix Reviewed-by format.Tomas Volf2024-06-241-4/+5
| | | | | | | | | | | | 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>
* doc: Refer to mumi send-email in Submitting Patches.Arun Isaac2024-06-121-5/+6
| | | | | | * doc/contributing.texi (Submitting Patches): Refer to mumi send-email. Change-Id: I009cdc306220ef63e6641fac69d3453ab169bfa2
* doc: Add mumi CLI concept index entries.Arun Isaac2024-06-121-0/+5
| | | | | | | * doc/contributing.texi (Debbugs User Interfaces)[Command-line interface]: Add mumi CLI concept index entries. Change-Id: Ic2e67226c18e87a7360b938476a662aae76dd58e
* doc: Document mumi am, compose and www subcommands.Arun Isaac2024-06-121-10/+60
| | | | | | | | * 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
* configure.ac: Set default value for the 'prefix' variable.Maxim Cournoyer2024-05-251-14/+1
| | | | | | | | | | | | | | | 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
* maint: Suggest ‘guix git authenticate’ for initial authentication.Ludovic Courtès2024-05-251-7/+23
| | | | | | | | | | | | | | | | | | | | | | | 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
* doc: Make changes to the handling of branches.Christopher Baines2024-05-221-17/+51
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* doc: contributing: Move localstatedir instructions.Florian Pelz2024-04-261-17/+17
| | | | | | | * doc/contributing.texi (Requirements): Move localstatedir ... (Building from Git): ... here. Change-Id: I860bb7a9e6aea12881469c667496364248293c31
* doc: contributing: Suggest building from Git.Florian Pelz2024-04-261-0/+8
| | | | | | | * doc/contributing.texi (Requirements): Explain the purpose of this section. Refer regular contributors to Building from Git. Change-Id: I731af4ac8e78b053b96a3b683528964223ab740b
* doc: Move "Running the Test Suite" after "Building from Git".Matthew Trzcinski2024-04-061-0/+98
| | | | | | | | * 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>
* doc: Move "Requirements" before "Building from Git"Matthew Trzcinski2024-04-061-0/+98
| | | | | | | | * 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>
* doc: Explain to run bootstrap after Automake errors.Florian Pelz2024-04-051-0/+4
| | | | | | | | | | 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
* doc: Add “Source Tree Structure” section.Ludovic Courtès2024-03-211-1/+253
| | | | | | | * doc/contributing.texi (Source Tree Structure): New node. * doc/guix.texi (Programming Interface): Add cross-reference. Change-Id: I141a1f4d806ae5f72c7a246e18c14dc63056a607
* doc: contributing: Remove sentences appearing twice.Simon Tournier2024-02-031-6/+1
| | | | | | | * doc/contributing.texi (Commit Access): Remove sentences appearing twice and use @url. Change-Id: I2b0cb9eebc6f9f66147f286c0bdffdf8924ec412
* doc: contributing: Fix typo.Simon Tournier2024-02-021-1/+1
| | | | | | * doc/contributing.texi (Reviewing the Work of Others): Fix typo. Change-Id: I4d3afd4f7e47dbda8a43fdf7f18c7c233d1c8762
* doc: Mention the responsibilities that blocking comes with.Maxim Cournoyer2024-02-021-1/+12
| | | | | | | | * doc/contributing.texi (Commit Access): Mention that blocking comes with extra responsibilities. Reviewed-by: Simon Tournier <zimon.toutoune@gmail.com> Signed-off-by: Simon Tournier <zimon.toutoune@gmail.com>
* doc: Use accurate wording in Emacs-Debbugs configuration.Florian Pelz2023-12-311-1/+1
| | | | | | | | | | | 'M-x debbugs-gnu' does not prompt for which bugs to show. 'C-u M-x debbugs-gnu' would. Follow-up to 19fe24c5b978a16cbca3cddbfa3ab9d1ee2c68f2. * doc/contributing.texi (Viewing Bugs within Emacs): Make comment more accurate. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* doc: suggest using pre-inst-env for git-send-email on foreign distrosRaphaël Mélotte2023-12-111-0/+5
| | | | | | | | | | | | On foreign distros, not using pre-inst-env when using git-send-email results in a backtrace ending with: no code for module (guix ui) This can be confusing as users did not have to use pre-inst-env to use git-send-email before. * doc/contributing.texi (Sending a Patch Series): add a note to suggest using pre-inst-env when calling git-send-email on foreign distros. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Recommend building in ‘guix shell -CPW’.Ludovic Courtès2023-12-041-2/+4
| | | | | | | | | | | | This was prompted by <https://issues.guix.gnu.org/66537>, where someone tried to build Guix within ‘guix shell --pure’ on a foreign distro and found that ./configure would pick software from the host system. Suggested by Hiep Pham <hiepph9@proton.me>. * doc/contributing.texi (Building from Git): Recommend ‘guix shell -CPW’. Change-Id: I7694b482d982917fef6ec404f68ddacea761f482
* doc: contributing: Fix syntax in link.Ekaitz Zarraga2023-11-201-1/+1
| | | | | | | | * doc/contributing.texi(Alternative Setups)[Vim and Neovim]: Fix broken link to fugitive.vim. Change-Id: Ib86239d98c39383169a9cdebc7549477b648206e Signed-off-by: Christopher Baines <mail@cbaines.net>
* doc: Document extra Emacs-Debbugs configurations.Maxim Cournoyer2023-11-071-0/+17
| | | | | | | | | * doc/contributing.texi (Viewing Bugs within Emacs): Document debbugs-gnu-default-packages, debbugs-gnu-default-severities. (Debbugs User Interfaces): Likewise, and mention debbugs-gnu-guix-search. Suggested-by: Michael Albinus <michael.albinus@gmx.de> Change-Id: I8e9026bc394b0cf674c8498ca713c332e48c2700
* doc: Expound on the build-side versus host-side modules topic.Maxim Cournoyer2023-11-071-2/+7
| | | | | | | | | | Discussed in <https://issues.guix.gnu.org/65924#98-lineno27>. * doc/contributing.texi (Modules): Add new context indices, and provide a real-life counter-example, and its ramifications. Reported-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I06975fb24f0d67c833884313a727dc550f61d8a0
* doc: Add some guidelines for reviewing.Maxim Cournoyer2023-11-071-4/+107
| | | | | | | | | | | * doc/contributing.texi (Contributing) [Reviewing the Work of Others]: New section. (Debbugs Usertags): Expound with Emacs Debbugs information and document the 'reviewed-looks-good' usertag. * etc/git/gitconfig [b4]: New section. Change-Id: I56630b15ec4fbc5c67e5420dbf2838556a005d6b Reviewed-by: Ludovic Courtès <ludo@gnu.org>
* doc: Update URL of Mumi git repository.Ricardo Wurmus2023-11-071-1/+1
| | | | | | * doc/contributing.texi (Debbugs User Interfaces): Use new repository URL. Change-Id: Ieccf34be8a103740607d8c115120902dc687d4e7
* doc: contributing: Replace reference to dunst.scm.Jaeme Sifat2023-11-051-1/+1
| | | | | | | | | | | The contributing documentation makes a reference to dunst.scm as an example of the build process failing after an update. This patch replaces that reference with a much more permanent linux.scm. * doc/contributing.texi: Replace reference to dunst.scm. Change-Id: I89a4157eb253e25979bc35d6d3b12201a0d19951 Signed-off-by: Christopher Baines <mail@cbaines.net>
* doc: contributiong: Fix ref usage.Julien Lepiller2023-11-011-1/+1
| | | | | | | | Previous usage renders as "see See Teams". * doc/contributing.texi: Fix ref usage. Change-Id: I97a91697ecb87d07cc3c962a79d87dd290a70a7c
* doc: Document Cuirass build notifications.Maxim Cournoyer2023-10-231-1/+39
| | | | | | | | * doc/contributing.texi (Tracking Bugs and Changes) <Cuirass Build Notifications>: New subsection. Change-Id: Icead24ec18cd4511ee6217aae3c1d11ec552a9c7 Reviewed-by: Mathieu Othacehe <othacehe@gnu.org>
* build: Add a commit-msg hook that embeds Change-Id in commit messages.Maxim Cournoyer2023-10-221-1/+9
| | | | | | | | | | | | | | | | | | Partially implements <https://issues.guix.gnu.org/66027>. This will make it possible to track a merged commit back to its original posting on the mailing list, and open the door to new opportunities such as closing fully merged series automatically. * Makefile.am (COMMIT_MSG_MAGIC): New variable. (.git/hooks/commit-msg): New target. * etc/git/commit-msg: New file. * doc/contributing.texi (Configuring Git): Document Change-Id. Series-changes: 3 - Clarify documentation text, as suggested by Simon Change-Id: Ia92fa958eae600fdd4e180bad494c85db8bb4dd6 Reviewed-by: Simon Tournier <zimon.toutoune@gmail.com>
* doc: Suggest keeping record type descriptors private.Ludovic Courtès2023-10-051-0/+11
| | | | | | | * doc/contributing.texi (Data Types and Pattern Matching): Add paragraph about keeping RTDs private. Suggested-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* doc: Update bug-reference configuration snippet.Mekeor Melire2023-10-051-2/+6
| | | | | | | | | * doc/contributing.texi (The Perfect Setup) <Viewing Bugs within Emacs>: Make bug-reference-bug-regexp match more URLs based on issues.guix.gnu.org. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Suggested-by: Simon Tournier <zimon.toutoune@gmail.com>
* doc: contributing: Add alternative setups section.Ekaitz Zarraga2023-10-051-7/+78
| | | | | | | | | Start with Guile Studio and Vim/NeoVim. * doc/contributing.texi (Alternative Setups): Add section explaining other setups that are similar to the one in The Perfect Setup. Signed-off-by: Efraim Flashner <efraim@flashner.co.il>
* doc: Update bug-reference configuration snippet.Maxim Cournoyer2023-09-261-4/+9
| | | | | | | | | * doc/contributing.texi (The Perfect Setup) <Viewing Bugs within Emacs>: Properly quote Elisp functions. Add 'require' directives. Set BUG-REFERENCE-URL-FORMAT so the configuration is self-contained. Suggested-by: Mekeor Melire <mekeor@posteo.de>
generated by cgit v1.2.3 (git 2.47.1) at 2025-01-18 09:10:20 +0000