summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
AgeCommit message (Collapse)Author
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.
2018-07-13etc: snippets: Add guix-commit-message-use-https-home-page.Arun Isaac
* etc/snippets/text-mode/guix-commit-message-use-https-home-page: New file. * doc/contributing.texi (The Perfect Setup): Document new snippet.
2018-07-04doc: Mention the build environment.Ludovic Courtès
* doc/contributing.texi (Running Guix Before It Is Installed): Add a note about having the dependencies available.
2018-06-16doc: Clarify when branches are "frozen".Marius Bakke
* doc/contributing.texi (Submitting Patches): Provide a link to Hydra. Add section about freezing branches.
2018-06-09pull: Install the new Guix in a profile.Ludovic Courtès
* 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.
2018-04-27doc: Add tips for Vim users.Ludovic Courtès
* doc/contributing.texi (Formatting Code): Add a paragraph about Vim.
2018-01-17doc: Suggest running guix-daemon with 'sudo -E'.Ludovic Courtès
Suggested by Martin H. <maze@strahlungsfrei.de>. * doc/contributing.texi (Running Guix Before It Is Installed): Suggest 'sudo -E'.
2017-12-15etc: Add snippets.Ricardo Wurmus
* 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.
2017-11-08doc: Move paragraph about signature verification to the top.Ricardo Wurmus
* doc/contributing.texi (Submitting Patches): Remind contributors to verify cryptographic signatures at the very beginning.
2017-09-19doc: Add a note about closing bug threads.Jan Nieuwenhuizen
* 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>
2017-09-19doc: Add "Sending a Patch Series" subsection.Jan Nieuwenhuizen
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.
2017-08-07Revert "doc: Suggest running guix-daemon with 'sudo -E'."Leo Famulari
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.
2017-08-06doc: Suggest running guix-daemon with 'sudo -E'.Ludovic Courtès
Suggested by Martin H. <maze@strahlungsfrei.de>. * doc/contributing.texi (Running Guix Before It Is Installed): Suggest 'sudo -E'.
2017-07-20doc: Show the "git clone" command.Ludovic Courtès
Suggested by Joshua Branson <jbranso91@gmail.com>. * doc/contributing.texi (Building from Git): Add "git clone" command.
2017-06-25doc: Encourage signature verification.Ricardo Wurmus
* doc/contributing.texi (Submitting Patches): Remind contributors to verify cryptographic signatures.
2017-05-13doc: Document the branching and rebuild scheduling strategy.Ludovic Courtès
* doc/contributing.texi (Submitting Patches): Document the branching scheme.
2017-05-04doc: Add references to Emacs-Guix manual.Alex Kost
* doc/htmlxref.cnf: Add links to the real manual. * doc/contributing.texi (Formatting Code): Add reference to it. * doc/guix.texi (Package Management): Likewise.
2017-02-13doc: Update patch submission instructions.Ludovic Courtès
* doc/contributing.texi (Submitting Patches): Add paragraph on guix-patches@gnu.org.
2017-01-13etc: Support indentation of whole files.Ludovic Courtès
* 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.
2017-01-12etc: Add 'indent-package.el' script.Ludovic Courtès
* 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>
2016-12-29Remove Emacs interface.Alex Kost
* 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>
2016-12-14doc: Fix typo in Submitting Patches section.Maxim Cournoyer
* doc/contributing.texi (Submitting Patches): Fix "could could" typo. Signed-off-by: Leo Famulari <leo@famulari.name>
2016-07-28doc: Discourage software bundling.Ludovic Courtès
Fixes <http://bugs.gnu.org/24008>. Suggested by ng0 <ng0@we.make.ritual.n0.is>. * doc/contributing.texi (Submitting Patches): Add item about bundling.
2016-07-28doc: Send changes in your patch which are related.ng0
* 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>
2016-07-28doc: Mention separate branch for packages with many dependents.Ludovic Courtès
Suggested by ng0 <ng0@we.make.ritual.n0.is>. * doc/contributing.texi (Submitting Patches): Add note on packages with more than 100 dependents.
2016-07-24doc: Point out preference of message format.ng0
* 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>
2016-07-24doc: Explain that contributors can use a pseudonym.Ludovic Courtès
Suggested by ng0 <ng0@we.make.ritual.n0.is>. * doc/contributing.texi (Contributing): Explain that using a legal name is not required.
2016-07-22doc: Add note on gender-neutral wording.Ludovic Courtès
Suggested by ng0 <ng0@we.make.ritual.n0.is>. * doc/contributing.texi (Submitting Patches): Add @item regarding gender-neutral wording.
2016-04-16doc: Mention --localstatedir for when building from Git.Ludovic Courtès
Reported by Hartmut Goebel <h.goebel@crazy-compilers.com>. * doc/contributing.texi (Building from Git): Mention --localstatedir.
2016-03-11doc: Add footnote about pointing ~/.config/guix/latest at user's checkoutChristopher Allan Webber
* doc/contributing.texi (Running Guix Before It Is Installed): New footnote.
2016-02-24doc: Fix minor typos and add missing words.Chris Marusich
* doc/guix.texi (Shepherd Services): Add missing words. (Invoking guix system): Fix typo. (Service Types and Services): Fix typo. * doc/contributing.texi (Submitting Patches): Fix typo. Signed-off-by: Andreas Enge <andreas@enge.fr>
2015-12-09doc: rephrase code of conduct.Alex Sassmannshausen
* doc/contributing.texi (Contributing): Rephrase 'code of conduct' section. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2015-12-09Add "Contributor Covenant".Ludovic Courtès
* CODE-OF-CONDUCT: New file, adapted from <http://contributor-covenant.org/version/1/3/0/code_of_conduct.txt>. * doc/contributing.texi (Contributing): Mention it. * Makefile.am (EXTRA_DIST): Add it.
2015-12-08guix build: Add '--rounds'.Ludovic Courtès
* guix/scripts/build.scm (show-build-options-help) (%standard-build-options): Add --rounds. (set-build-options-from-command-line): Honor it. * doc/guix.texi (Invoking guix build): Document it. * doc/contributing.texi (Submitting Patches): Mention it.
2015-11-22doc: Mention 'guix environment guix'.Ludovic Courtès
* doc/contributing.texi (Building from Git): Mention 'guix environment guix'. Remove outdated description of ./bootstrap. Clarify a few things.
2015-11-21doc: Remove extraneous "See."Ludovic Courtès
* doc/contributing.texi (Building from Git): Remove extra "See" and use @xref instead of @pxref.