summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
AgeCommit message (Collapse)Author
2020-11-12maint: update-guix-package: Optionally add sources to store.Maxim Cournoyer
Following discussions in <https://issues.guix.gnu.org/43893>, keeping a copy of the updated package source is desirable when generating a release. * build-aux/update-guix-package.scm (version-controlled?): Remove variable. (call-with-temporary-git-worktree): Renamed from 'with-temporary-git-worktree'. Update doc. Do not change directory implicitly. Define as a procedure, not a syntax. (keep-source-in-store): New procedure. (main): Adjust to use with call-with-temporary-git-worktree. Add the sources to the store when GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT is set. Exit gracefully when FIND-ORIGIN-REMOTE returns #f. (%savannah-guix-git-repo-push-url-regexp): Adjust match for a potential colon separator. * Makefile.am (GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT): Adjust. * .dir-locals.el (scheme-mode): Remove entry for with-temporary-git-worktree. * doc/contributing.texi (Updating the Guix Package): Update doc. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2020-10-24build: Add GUIX_GIT_KEYRING variable for make authenticate.Miguel Ángel Arruga Vivas
* Makefile.am (GUIX_GIT_KEYRING): New variable. (authenticate): Use GUIX_GIT_KEYRING to select the keyring branch reference. * doc/contributing.texi (Building from Git): Add an example about the use of GUIX_GIT_KEYRING.
2020-10-20doc: More uses of @lisp instead of @example.Ludovic Courtès
* doc/guix.texi (G-Expressions): Use @lisp for 'let-system' example. * doc/contributing.texi (Synopses and Descriptions): Use @lisp for second example.
2020-10-19maint: update-guix-package: Prevent accidentally breaking guix pull.Maxim Cournoyer
Fixes <https://issues.guix.gnu.org/43893>. This changes the 'update-guix-package' tool so that it: 1. Always uses a clean checkout to compute the hash of the updated 'guix' package. 2. Ensures the commit used in the updated 'guix' package definition has already been pushed upstream. * build-aux/update-guix-package.scm (%savannah-guix-git-repo-push-url): New variable. (with-input-pipe-to-string, with-temporary-git-worktree): New syntaxes. (find-origin-remote, git-add-worktree): New procedures. (commit-already-pushed?): New predicate. (main): Check the commit used has already been pushed upstream and compute the hash from a clean checkout. * doc/contributing.texi (Updating the Guix Package): Document it. * .dir-locals.el (scheme-mode): Fix indentation of with-temporary-git-worktree.
2020-10-08doc: Clarify that guix-daemon doesn't have to be launched from the checkout.Ludovic Courtès
Suggested by Emmanuel Agullo. * doc/contributing.texi (Running Guix Before It Is Installed): Move the "./pre-inst-env guix-daemon" snippet at the bottom. Make it clear that it's necessary only when hacking on guix-daemon or when guix-daemon is not already running.
2020-10-08doc: Developers don't need to run "make install" in Guix.Ludovic Courtès
Suggested by Emmanuel Agullo. * doc/contributing.texi (Building from Git): Mention that running "make install" is unnecessary.
2020-09-18doc: Fix broken hyperlinks in the contribution instructions.Greg Hogan
* doc/contributing.texi (Packaging Guidelines, Submitting Patches): Change URLs from relative to absolute links.
2020-09-12doc: Document the use of snippets vs phases.Maxim Cournoyer
* doc/contributing.texi (Snippets versus phases): New section.
2020-08-27doc: Improve the instructions regarding `guix git authenticate`.Joshua Branson
* doc/contributing.texi (Building from Git): Instruct the user to fetch the 'keyring' branch. Fix a typo. Signed-off-by: Leo Famulari <leo@famulari.name>
2020-07-23doc: Recommend running 'guix git authenticate' when cloning the repo.Ludovic Courtès
* doc/contributing.texi (Building from Git): Adjust instruction and recommend 'guix git authenticate'.
2020-07-09doc: Fix typo.Tobias Geerinckx-Rice
* doc/contributing.texi (The Perfect Setup): Fix spelling & placement of ‘additionally’.
2020-06-20doc: Make issues.guix.gnu.org more visible.Ludovic Courtès
* doc/contributing.texi (Tracking Bugs and Patches): Make issues.guix.gnu.org more visible, update issue URL.
2020-06-16doc: Recommend "make authenticate" after ./bootstrap.Ludovic Courtès
* doc/contributing.texi (Building from Git): Move "make authenticate" instructions below.
2020-06-14doc: Adjust branching and rebuilding strategy to match reality.Marius Bakke
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.
2020-05-28doc: Remove explicit support for mips64el-linux.Efraim Flashner
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.
2020-05-25doc: Fix typos.zimoun
* doc/guix.texi: Fix typos. * doc/contributing.texi: Fix typos. Signed-off-by: Julien Lepiller <julien@lepiller.eu>
2020-05-22maint: Add "make check-channel-news".Ludovic Courtès
* 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".
2020-05-12doc: Specify the branch name in the title of a patch.Brice Waegeneire
* doc/contributing.texi (Submitting Patches): Add branch name in the title of a patch if different than master.
2020-05-04doc: Recommend against SHA1 OpenPGP signatures.Ludovic Courtès
* doc/contributing.texi (Commit Access): Recommend against SHA1 signatures.
2020-05-04doc: Document committer authorization.Ludovic Courtès
* doc/contributing.texi (Commit Access): Add instructions for authorizing committers.
2020-03-13doc: Update guidance about Python 2 package variants.Leo Famulari
* doc/contributing.texi (Python Modules): Don't recommend adding Python-2 package variants by default.
2020-03-10doc: Use HTTPS for external links.Vitaliy Shatrov
* 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>
2020-03-09doc: Use an https link for Contributor Covenant.Jakub Kądziołka
* doc/contributing.texi: Switch to https for the link to contributor-covenant.org Reported-By: guix-vits on IRC
2020-02-22etc: Add copyright.Oleg Pykhalov
* etc/copyright.el: New file. * doc/contributing.texi (The Perfect Setup): Document this.
2020-02-18doc: Document packaging guidelines for Rust crates.Efraim Flashner
* doc/contributing.texi (Rust Crates): New section.
2020-01-19Use HTTPS for www.emacswiki.org.Tobias Geerinckx-Rice
* 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.
2020-01-09doc: Add a cooptation policy for commit access.Ludovic Courtès
* doc/contributing.texi (Commit Access): Draft a cooptation policy.
2020-01-09doc: Encourage patch review.Ludovic Courtès
* doc/contributing.texi (Commit Access): Add note about patch review.
2020-01-09doc: Move "Commit Access" section from 'HACKING' to the manual.Ludovic Courtès
* HACKING (Commit Access): Remove. (Contributing): Update URL of the manual. * doc/contributing.texi (Commit Access): New section. (Submitting Patches): Add cross reference.
2020-01-09doc: Add "Tracking Bugs and Patches" section.Ludovic Courtès
* 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.
2019-12-27doc: Mention "make authenticate".Ludovic Courtès
* doc/contributing.texi (Building from Git): Add instructions to run 'git verify-commit' and 'make authenticate'.
2019-12-13doc: Link to "Building from Git" instead of quoting command to build Guix.Pierre Neidhardt
* doc/contributing.texi (Submitting Patches): Remove example. Add link to "Building from Git" section.
2019-12-08doc: Mention how to simulate a `guix pull' before submitting patches.Pierre Neidhardt
* doc/contributing.texi (Submitting Patches): Mention the dummy guix pull command in the check list.
2019-12-08doc: Mention how to rebuild guix before submitting patches.Pierre Neidhardt
* doc/contributing.texi (Submitting Patches): Mention rebuild command in the check list.
2019-11-09doc: Mention value /var to localstatedir option.zimoun
* 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>
2019-09-07doc: Use @lisp instead of @example for Scheme snippets.Ludovic Courtès
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.
2019-07-17doc: Reorder and clarify contributing instructions.Florian Pelz
* 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>
2019-07-15doc: note how to install git send-emailArne Babenhauserheide
* doc/contributing.texi (git send-email): Add install instructions. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2019-06-29doc: Remove references to hydra.gnu.org.Tobias Geerinckx-Rice
* 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.
2019-05-20doc: use pure environment when building from gitGiovanni Biscuolo
* doc/contributing.texi (Building from Git): Add --pure to "guix environment" invocations Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2019-03-24doc: Remove instances of powerpc-linux being a supported Guix architecture.Efraim Flashner
* doc/contributing.texi (Submitting Patches): Remove powerpc-linux examples. * doc/guix.texi (Virtualization Services): Replace powerpc-linux example with mips64el-linux.
2019-02-04doc: Document how to enable qemu binfmt service and how to use it.Danny Milosavljevic
* 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>
2019-02-04doc: Show how to install Emacs, Guile, and Geiser.Ludovic Courtès
* doc/contributing.texi (The Perfect Setup): Show "guix package -i" command line.
2019-01-22doc: Move "Packaging Guidelines" under "Contributing".Ludovic Courtès
* doc/guix.texi (Packaging Guidelines): Move to... * doc/contributing.texi (Packaging Guidelines): ... here. Turn into a section. Adjust references to "Contributing".
2018-12-15doc: Replace @command by @code for packagesPierre Neidhardt
* doc/contributing.texi (Submitting Patches): Replace @command by @code for packages.
2018-12-15doc: Merge "discourage use of texlive" with existing paragraph on "guix size"Pierre Neidhardt
* doc/contributing.texi (Submitting Patches): Merge "discourage use of texlive" with existing paragraph on "guix size".
2018-12-14doc: Discourage the use of texlive as inputPierre Neidhardt
* doc/contributing.texi (Submitting Patches): Discourage the use of texlive as input.
2018-12-04Remove most references to hydra.gnu.org.Ludovic Courtès
* 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.
2018-11-16doc: Mention that ./pre-inst-env is generated.Ludovic Courtès
Suggested by swedebugia <swedebugia@riseup.net>. * doc/contributing.texi (Running Guix Before It Is Installed): Mention that ./pre-inst-env is generated.
2018-10-10doc: Add recommendations for good origin URLs.Pierre Neidhardt
* doc/contributing.texi (Submitting Patches): URL recommendations.
generated by cgit v1.2.3 (git 2.46.2) at 2024-11-07 19:32:36 +0000