summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
AgeCommit message (Expand)Author
2020-06-20doc: Make issues.guix.gnu.org more visible....* doc/contributing.texi (Tracking Bugs and Patches): Make issues.guix.gnu.org more visible, update issue URL. Ludovic Courtès
2020-06-16doc: Recommend "make authenticate" after ./bootstrap....* doc/contributing.texi (Building from Git): Move "make authenticate" instructions below. Ludovic Courtès
2020-06-14doc: Adjust branching and rebuilding strategy to match reality....The amount of packages has more than tripled since this section was written. Adjust the rebuild limits and cycle lengths based on current practices. * doc/contributing.texi (Submitting Patches): Increase 'staging' rebuild limit to 1800 packages, and adjust the cycle to six weeks. Increase 'core-updates' cycle to six months. Marius Bakke
2020-05-28doc: Remove explicit support for mips64el-linux....It's been a good run, but no one is maintaining the architecture. So long, and thanks for all the fish. * doc/guix.texi (GNU Distribution): Change text for mips64el-linux to denote it is deprecated. (Daemon Offload Setup): Change occurrences of mips64el-linux to aarch64-linux and adjust local code snippets. (Guix Environment)[cross-compilation]: Change mips64el-linux-gnu to aarch64-linux-gnu. (GNU Build System)(package-cross-derivation]: Same. (G-Expressions)[cross compilation]: Same. (Additional Build Options)[cross-compilation, build logs]: Same. (qemu-binfmt-service-type): Remove mips64el. * doc/contributing.texi (Submitting Patches): Same. * m4/guix.m4: (GUIX_ASSERT_SUPPORTED_SYSTEM): Remove mips64el-linux. Efraim Flashner
2020-05-25doc: Fix typos....* doc/guix.texi: Fix typos. * doc/contributing.texi: Fix typos. Signed-off-by: Julien Lepiller <julien@lepiller.eu> zimoun
2020-05-22maint: Add "make check-channel-news"....* build-aux/check-channel-news.scm: New file. * Makefile.am (EXTRA_DIST): Add it. (check-channel-news): New phony rule. * doc/contributing.texi (Commit Access): Mention "make check-channel-news". Ludovic Courtès
2020-05-12doc: Specify the branch name in the title of a patch....* doc/contributing.texi (Submitting Patches): Add branch name in the title of a patch if different than master. Brice Waegeneire
2020-05-04doc: Recommend against SHA1 OpenPGP signatures....* doc/contributing.texi (Commit Access): Recommend against SHA1 signatures. Ludovic Courtès
2020-05-04doc: Document committer authorization....* doc/contributing.texi (Commit Access): Add instructions for authorizing committers. Ludovic Courtès
2020-03-13doc: Update guidance about Python 2 package variants....* doc/contributing.texi (Python Modules): Don't recommend adding Python-2 package variants by default. Leo Famulari
2020-03-10doc: Use HTTPS for external links....* doc/contributing.texi (14.1 Building from Git, 14.3 The Perfect Setup, 14.4.1 Software Freedom, 14.4.4 Synopses and Descriptions, 14.5.4 Formatting Code): Use HTTPS for @uref{}s and @url{}s that support it. * doc/fdl-1.3.texi (Appendix A GNU Free Documentation License): Use HTTPS for @uref{}s and @url{}s that support it. * doc/guix.texi (6.3 Build Systems, 8.8.4 Networking Services, 8.8.8 Sound Services, 8.8.16 Web Services, 8.11 Name Service Switch, 12.2 Preparing to Use the Bootstrap Binaries); Use HTTPS for @uref{}s and @url{}s that support it. Signed-off-by: Marius Bakke <mbakke@fastmail.com> Vitaliy Shatrov
2020-03-09doc: Use an https link for Contributor Covenant....* doc/contributing.texi: Switch to https for the link to contributor-covenant.org Reported-By: guix-vits on IRC Jakub Kądziołka
2020-02-22etc: Add copyright....* etc/copyright.el: New file. * doc/contributing.texi (The Perfect Setup): Document this. Oleg Pykhalov
2020-02-18doc: Document packaging guidelines for Rust crates....* doc/contributing.texi (Rust Crates): New section. Efraim Flashner
2020-01-19Use HTTPS for www.emacswiki.org....* doc/contributing.texi (The Perfect Setup): Use HTTPS for ParEdit wiki page. * gnu/packages/emacs-xyz.scm (emacs-wget, emacs-iedit)[home-page]: Use HTTPS. (emacs-transpose-frame)[source]: Likewise. Tobias Geerinckx-Rice
2020-01-09doc: Add a cooptation policy for commit access....* doc/contributing.texi (Commit Access): Draft a cooptation policy. Ludovic Courtès
2020-01-09doc: Encourage patch review....* doc/contributing.texi (Commit Access): Add note about patch review. Ludovic Courtès
2020-01-09doc: Move "Commit Access" section from 'HACKING' to the manual....* HACKING (Commit Access): Remove. (Contributing): Update URL of the manual. * doc/contributing.texi (Commit Access): New section. (Submitting Patches): Add cross reference. Ludovic Courtès
2020-01-09doc: Add "Tracking Bugs and Patches" section....* doc/contributing.texi (Tracking Bugs and Patches): New section. (Submitting Patches): Refer to it. * doc/guix.texi: Update copyright line. * HACKING (Using emacs-debbugs): Remove. Ludovic Courtès
2019-12-27doc: Mention "make authenticate"....* doc/contributing.texi (Building from Git): Add instructions to run 'git verify-commit' and 'make authenticate'. Ludovic Courtès
2019-12-13doc: Link to "Building from Git" instead of quoting command to build Guix....* doc/contributing.texi (Submitting Patches): Remove example. Add link to "Building from Git" section. Pierre Neidhardt
2019-12-08doc: Mention how to simulate a `guix pull' before submitting patches....* doc/contributing.texi (Submitting Patches): Mention the dummy guix pull command in the check list. Pierre Neidhardt
2019-12-08doc: Mention how to rebuild guix before submitting patches....* doc/contributing.texi (Submitting Patches): Mention rebuild command in the check list. Pierre Neidhardt
2019-11-09doc: Mention value /var to localstatedir option....* README (Installing Guix from Guix): Mention value /var to localstatedir option. * doc/contributing.texi (Building from Git): Likewise. * doc/guix.texi (Requirements): Likewise. Signed-off-by: Ludovic Courtès <ludo@gnu.org> zimoun
2019-09-07doc: Use @lisp instead of @example for Scheme snippets....This is a followup to f8c143a7131d6f40f387f4cd2ad1fa78b5e2f429, which allows syntax highlighting of @lisp snippets in the HTML output. * doc/guix.texi, doc/contributing.texi: Use @lisp instead of @example for all the Scheme snippets. Ludovic Courtès
2019-07-17doc: Reorder and clarify contributing instructions....* doc/contributing.texi (Building from Git, Running Guix Before It Is Installed): Make instructions using Guix come first and clarify which code is an instruction and which is merely an example. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Florian Pelz
2019-07-15doc: note how to install git send-email...* doc/contributing.texi (git send-email): Add install instructions. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Arne Babenhauserheide
2019-06-29doc: Remove references to hydra.gnu.org....* doc/contributing.texi (Packaging Guidelines, Submitting Patches): Replace hydra URL with @value{SUBSTITUTE-SERVER}. * doc/guix.texi (Official Substitute Server): Remove ‘hydra’ @cindex. (Substitute Server Authorization): Remove note about hydra.gnu.org.pub. Tobias Geerinckx-Rice
2019-05-20doc: use pure environment when building from git...* doc/contributing.texi (Building from Git): Add --pure to "guix environment" invocations Signed-off-by: Ludovic Courtès <ludo@gnu.org> Giovanni Biscuolo
2019-03-24doc: Remove instances of powerpc-linux being a supported Guix architecture....* doc/contributing.texi (Submitting Patches): Remove powerpc-linux examples. * doc/guix.texi (Virtualization Services): Replace powerpc-linux example with mips64el-linux. Efraim Flashner
2019-02-04doc: Document how to enable qemu binfmt service and how to use it....* doc/contributing.texi (Submitting Patches): Document how to enable qemu binfmt service and how to use it. Co-authored-by: Ricardo Wurmus <rekado@elephly.net> Danny Milosavljevic
2019-02-04doc: Show how to install Emacs, Guile, and Geiser....* doc/contributing.texi (The Perfect Setup): Show "guix package -i" command line. Ludovic Courtès
2019-01-22doc: Move "Packaging Guidelines" under "Contributing"....* doc/guix.texi (Packaging Guidelines): Move to... * doc/contributing.texi (Packaging Guidelines): ... here. Turn into a section. Adjust references to "Contributing". Ludovic Courtès
2018-12-15doc: Replace @command by @code for packages...* doc/contributing.texi (Submitting Patches): Replace @command by @code for packages. Pierre Neidhardt
2018-12-15doc: Merge "discourage use of texlive" with existing paragraph on "guix size"...* doc/contributing.texi (Submitting Patches): Merge "discourage use of texlive" with existing paragraph on "guix size". Pierre Neidhardt
2018-12-14doc: Discourage the use of texlive as input...* doc/contributing.texi (Submitting Patches): Discourage the use of texlive as input. Pierre Neidhardt
2018-12-04Remove most references to hydra.gnu.org....* Makefile.am (assert-binaries-available): Don't mention hydra.gnu.org in comment. * build-aux/check-available-binaries.scm: Likewise. * build-aux/check-final-inputs-self-contained.scm: Likewise. * doc/guix.texi (SUBSTITUTE-SERVER): New variable. Use it throughout instead of "mirror.hydra.gnu.org". * doc/contributing.texi (Submitting Patches): Likewise. * gnu/services/base.scm (hydra-key-authorization) (guix-activation): Remove mentions of "hydra.gnu.org" in comments and messages. * gnu/system/install.scm (%installation-services): Likewise. * guix/scripts/size.scm (guix-size): Likewise. Ludovic Courtès
2018-11-16doc: Mention that ./pre-inst-env is generated....Suggested by swedebugia <swedebugia@riseup.net>. * doc/contributing.texi (Running Guix Before It Is Installed): Mention that ./pre-inst-env is generated. Ludovic Courtès
2018-10-10doc: Add recommendations for good origin URLs....* doc/contributing.texi (Submitting Patches): URL recommendations. Pierre Neidhardt
2018-07-13etc: snippets: Add guix-commit-message-use-https-home-page....* etc/snippets/text-mode/guix-commit-message-use-https-home-page: New file. * doc/contributing.texi (The Perfect Setup): Document new snippet. Arun Isaac
2018-07-04doc: Mention the build environment....* doc/contributing.texi (Running Guix Before It Is Installed): Add a note about having the dependencies available. Ludovic Courtès
2018-06-16doc: Clarify when branches are "frozen"....* doc/contributing.texi (Submitting Patches): Provide a link to Hydra. Add section about freezing branches. Marius Bakke
2018-06-09pull: Install the new Guix in a profile....* guix/scripts/pull.scm (%pull-version): New variable. (build-from-source): Pass #:pull-version to BUILD. (whole-package-for-legacy, derivation->manifest-entry): New procedure. (build-and-install): Rewrite in terms of 'build-and-use-profile'. * guix/scripts/system.scm (maybe-suggest-running-guix-pull)[latest]: Switch to "/current". * scripts/guix.in (augment-load-paths!): Remove use of ~/.config/guix/latest. * build-aux/compile-as-derivation.scm: Replace "/guix/latest/" with "/current/share/guile/site/X.Y" * guix/scripts.scm (warn-about-old-distro)[age]: Check "/current" instead of "/latest". * doc/guix.texi (Invoking guix pull): Document it. * doc/contributing.texi (Running Guix Before It Is Installed): Remove footnote about abusing ~/.config/guix/latest. Ludovic Courtès
2018-04-27doc: Add tips for Vim users....* doc/contributing.texi (Formatting Code): Add a paragraph about Vim. Ludovic Courtès
2018-01-17doc: Suggest running guix-daemon with 'sudo -E'....Suggested by Martin H. <maze@strahlungsfrei.de>. * doc/contributing.texi (Running Guix Before It Is Installed): Suggest 'sudo -E'. Ludovic Courtès
2017-12-15etc: Add snippets....* etc/snippets/scheme-mode/guix-cvs-reference, etc/snippets/scheme-mode/guix-git-reference, etc/snippets/scheme-mode/guix-hg-reference, etc/snippets/scheme-mode/guix-origin, etc/snippets/scheme-mode/guix-package, etc/snippets/scheme-mode/guix-svn-reference, etc/snippets/text-mode/guix-commit-message-add-package, etc/snippets/text-mode/guix-commit-message-update-package: New files. * doc/contributing.texi (The Perfect Setup): Document snippets. Ricardo Wurmus
2017-11-08doc: Move paragraph about signature verification to the top....* doc/contributing.texi (Submitting Patches): Remind contributors to verify cryptographic signatures at the very beginning. Ricardo Wurmus
2017-09-19doc: Add a note about closing bug threads....* doc/contributing.texi (Submitting Patches): Add a note about closing bug threads by mailing to NNN-done@debbugs.gnu.org. Suggested-by: Nicolas Goaziou <mail@nicolasgoaziou.fr> Jan Nieuwenhuizen
2017-09-19doc: Add "Sending a Patch Series" subsection....Searching for `git send-email' took you to the end of `Submitting Patches' section which said You may use your email client or the ‘git send-email’ command. without further warning or remark. * doc/contributing.texi (Sending a Patch Series): Move information about debbugs bug 15361 to subsection. Add git-send-email index entries. (Submitting Patches): Reference it. Jan Nieuwenhuizen
2017-08-07Revert "doc: Suggest running guix-daemon with 'sudo -E'."...This change might not correct, so we revert it for now: https://lists.gnu.org/archive/html/guix-devel/2017-08/msg00057.html This reverts commit 6a4364335c967f841b53ed35c22f90445437e4b0. Leo Famulari