summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
AgeCommit message (Expand)Author
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
2017-08-06doc: 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-07-20doc: Show the "git clone" command....Suggested by Joshua Branson <jbranso91@gmail.com>. * doc/contributing.texi (Building from Git): Add "git clone" command. Ludovic Courtès
2017-06-25doc: Encourage signature verification....* doc/contributing.texi (Submitting Patches): Remind contributors to verify cryptographic signatures. Ricardo Wurmus
2017-05-13doc: Document the branching and rebuild scheduling strategy....* doc/contributing.texi (Submitting Patches): Document the branching scheme. Ludovic Courtès
2017-05-04doc: Add references to Emacs-Guix manual....* doc/htmlxref.cnf: Add links to the real manual. * doc/contributing.texi (Formatting Code): Add reference to it. * doc/guix.texi (Package Management): Likewise. Alex Kost
2017-02-13doc: Update patch submission instructions....* doc/contributing.texi (Submitting Patches): Add paragraph on guix-patches@gnu.org. Ludovic Courtès
2017-01-13etc: Support indentation of whole files....* etc/indent-package.el.in: Rename to... * etc/indent-code.el.in: ... this. Add case for a single argument. * doc/contributing.texi (Formatting Code): Adjust accordingly. * configure.ac: Likewise. Ludovic Courtès
2017-01-12etc: Add 'indent-package.el' script....* configure.ac: Check for 'emacs', substitute 'EMACS', and emit 'etc/indent-package.el'. * etc/indent-package.el.in: New file. * doc/contributing.texi (Formatting Code): Mention 'etc/indent-package.el'. (Submitting Patches): Likewise, and link to the above node. Co-authored-by: Alex Kost <alezost@gmail.com> Ludovic Courtès
2016-12-29Remove Emacs interface....* emacs/guix-about.el: Remove file. * emacs/guix-backend.el: Likewise. * emacs/guix-base.el: Likewise. * emacs/guix-buffer.el: Likewise. * emacs/guix-build-log.el: Likewise. * emacs/guix-command.el: Likewise. * emacs/guix-config.el.in: Likewise. * emacs/guix-devel.el: Likewise. * emacs/guix-entry.el: Likewise. * emacs/guix-external.el: Likewise. * emacs/guix-geiser.el: Likewise. * emacs/guix-guile.el: Likewise. * emacs/guix-help-vars.el: Likewise. * emacs/guix-helper.scm.in: Likewise. * emacs/guix-history.el: Likewise. * emacs/guix-hydra-build.el: Likewise. * emacs/guix-hydra-jobset.el: Likewise. * emacs/guix-hydra.el: Likewise. * emacs/guix-info.el: Likewise. * emacs/guix-init.el: Likewise. * emacs/guix-license.el: Likewise. * emacs/guix-list.el: Likewise. * emacs/guix-location.el: Likewise. * emacs/guix-main.scm: Likewise. * emacs/guix-messages.el: Likewise. * emacs/guix-pcomplete.el: Likewise. * emacs/guix-popup.el: Likewise. * emacs/guix-prettify.el: Likewise. * emacs/guix-profiles.el: Likewise. * emacs/guix-read.el: Likewise. * emacs/guix-ui-generation.el: Likewise. * emacs/guix-ui-license.el: Likewise. * emacs/guix-ui-location.el: Likewise. * emacs/guix-ui-package.el: Likewise. * emacs/guix-ui-system-generation.el: Likewise. * emacs/guix-ui.el: Likewise. * emacs/guix-utils.el: Likewise. * emacs/local.mk: Likewise. * doc/emacs.texi: Likewise. * doc/guix.texi: Remove cross-references to Emacs nodes. (Package Management): Mention 'emacs-guix' package. * doc/contributing.texi (The Perfect Setup): Remove the reference. * doc/htmlxref.cnf: Add 'emacs-guix' URL. * Makefile.am: Remove Emacs stuff. * configure.ac: Likewise. * gnu/packages/package-management.scm (guix-0.12.0)[native-inputs]: Remove "emacs". [propagated-inputs]: Remove "geiser" and "emacs-magit-popup". Co-authored-by: Ludovic Courtès <ludo@gnu.org> Alex Kost
2016-12-14doc: Fix typo in Submitting Patches section....* doc/contributing.texi (Submitting Patches): Fix "could could" typo. Signed-off-by: Leo Famulari <leo@famulari.name> Maxim Cournoyer
2016-07-28doc: Discourage software bundling....Fixes <http://bugs.gnu.org/24008>. Suggested by ng0 <ng0@we.make.ritual.n0.is>. * doc/contributing.texi (Submitting Patches): Add item about bundling. Ludovic Courtès
2016-07-28doc: Send changes in your patch which are related....* doc/contributing.texi (Submitting Patches): New @item: This gives information about sending related changes and examples on what we view as related changes. Co-authored-by: Ludovic Courtès <ludo@gnu.org> ng0
2016-07-28doc: Mention separate branch for packages with many dependents....Suggested by ng0 <ng0@we.make.ritual.n0.is>. * doc/contributing.texi (Submitting Patches): Add note on packages with more than 100 dependents. Ludovic Courtès
2016-07-24doc: Point out preference of message format....* doc/contributing.texi (Submitting Patches): Includes a note on preference of plain text messages with either inline or MIME attachments and advise contributers to pay attention if their email client breaks the patches. Signed-off-by: Ludovic Courtès <ludo@gnu.org> ng0
2016-07-24doc: Explain that contributors can use a pseudonym....Suggested by ng0 <ng0@we.make.ritual.n0.is>. * doc/contributing.texi (Contributing): Explain that using a legal name is not required. Ludovic Courtès