Ludovic Courtès
63c799c1c5
doc: Recommend running 'guix git authenticate' when cloning the repo.
...
* doc/contributing.texi (Building from Git): Adjust instruction and
recommend 'guix git authenticate'.
2020-07-23 00:22:25 +02:00
Tobias Geerinckx-Rice
4f4fb2151e
doc: Fix typo.
...
* doc/contributing.texi (The Perfect Setup): Fix spelling & placement of ‘additionally’.
2020-07-09 19:57:40 +02:00
Ludovic Courtès
cdea526556
doc: Make issues.guix.gnu.org more visible.
...
* doc/contributing.texi (Tracking Bugs and Patches): Make
issues.guix.gnu.org more visible, update issue URL.
2020-06-20 13:18:11 +02:00
Ludovic Courtès
33391ee5c1
doc: Recommend "make authenticate" after ./bootstrap.
...
* doc/contributing.texi (Building from Git): Move "make authenticate"
instructions below.
2020-06-16 16:10:46 +02:00
Marius Bakke
bb9a99e657
doc: 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.
2020-06-14 23:15:21 +02:00
Efraim Flashner
03e6404936
doc: 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.
2020-05-28 11:12:40 +03:00
zimoun
ba2104aaa3
doc: Fix typos.
...
* doc/guix.texi: Fix typos.
* doc/contributing.texi: Fix typos.
Signed-off-by: Julien Lepiller <julien@lepiller.eu>
2020-05-25 14:46:03 +02:00
Ludovic Courtès
1ad5209d90
maint: 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".
2020-05-22 00:35:23 +02:00
Brice Waegeneire
a1891cbffb
doc: 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.
2020-05-12 22:10:11 +02:00
Ludovic Courtès
4a84deda74
doc: Recommend against SHA1 OpenPGP signatures.
...
* doc/contributing.texi (Commit Access): Recommend against SHA1
signatures.
2020-05-04 09:56:14 +02:00
Ludovic Courtès
84133320b8
doc: Document committer authorization.
...
* doc/contributing.texi (Commit Access): Add instructions for
authorizing committers.
2020-05-04 09:56:13 +02:00
Leo Famulari
39356057bc
doc: Update guidance about Python 2 package variants.
...
* doc/contributing.texi (Python Modules): Don't recommend adding Python-2
package variants by default.
2020-03-13 19:27:33 -04:00
Vitaliy Shatrov
21656ffa3b
doc: 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>
2020-03-10 20:26:52 +01:00
Jakub Kądziołka
478af02863
doc: 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
2020-03-09 09:34:39 +01:00
Oleg Pykhalov
9a39711438
etc: Add copyright.
...
* etc/copyright.el: New file.
* doc/contributing.texi (The Perfect Setup): Document this.
2020-02-22 17:56:31 +03:00
Efraim Flashner
8d1b22b27f
doc: Document packaging guidelines for Rust crates.
...
* doc/contributing.texi (Rust Crates): New section.
2020-02-18 09:51:44 +02:00
Tobias Geerinckx-Rice
c2c73f583d
Use 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.
2020-01-19 06:09:01 +01:00
Ludovic Courtès
ef09cb866c
doc: Add a cooptation policy for commit access.
...
* doc/contributing.texi (Commit Access): Draft a cooptation policy.
2020-01-09 23:33:04 +01:00
Ludovic Courtès
98ebcf1c1b
doc: Encourage patch review.
...
* doc/contributing.texi (Commit Access): Add note about patch review.
2020-01-09 23:33:04 +01:00
Ludovic Courtès
2d315cd428
doc: 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.
2020-01-09 23:33:04 +01:00
Ludovic Courtès
a7bde77d24
doc: 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.
2020-01-09 23:33:04 +01:00
Ludovic Courtès
b3011dbbd2
doc: Mention "make authenticate".
...
* doc/contributing.texi (Building from Git): Add instructions to run
'git verify-commit' and 'make authenticate'.
2019-12-27 13:52:49 +01:00
Pierre Neidhardt
da31e7d9ec
doc: 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.
2019-12-13 13:31:00 +01:00
Pierre Neidhardt
9fcf282058
doc: 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.
2019-12-08 16:34:32 +01:00
Pierre Neidhardt
bf99d7e0e2
doc: Mention how to rebuild guix before submitting patches.
...
* doc/contributing.texi (Submitting Patches): Mention rebuild command in the
check list.
2019-12-08 16:32:34 +01:00
zimoun
0758a70cc0
doc: 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>
2019-11-09 23:04:14 +01:00
Ludovic Courtès
8ba31e8bd1
doc: Use @lisp instead of @example for Scheme snippets.
...
This is a followup to f8c143a713
2019-09-07 18:42:08 +02:00
Florian Pelz
0636742b77
doc: 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>
2019-07-17 15:36:04 +02:00
Arne Babenhauserheide
fb8b99a5f5
doc: 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>
2019-07-15 12:48:49 +02:00
Tobias Geerinckx-Rice
44b5f28a77
doc: 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.
2019-06-29 06:28:50 +02:00
Giovanni Biscuolo
43ec98ef30
doc: 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>
2019-05-20 23:23:01 +02:00
Efraim Flashner
b28e4e3c0d
doc: 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.
2019-03-24 19:42:24 +02:00
Danny Milosavljevic
89339a35bd
doc: 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>
2019-02-04 17:56:28 +01:00
Ludovic Courtès
f73ab814a5
doc: Show how to install Emacs, Guile, and Geiser.
...
* doc/contributing.texi (The Perfect Setup): Show "guix package -i"
command line.
2019-02-04 00:03:30 +01:00
Ludovic Courtès
afe7408e19
doc: 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".
2019-01-22 23:04:06 +01:00
Pierre Neidhardt
0afeb7468c
doc: Replace @command by @code for packages
...
* doc/contributing.texi (Submitting Patches): Replace @command by @code for
packages.
2018-12-15 19:21:08 +01:00
Pierre Neidhardt
024e358cb9
doc: 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".
2018-12-15 00:20:35 +01:00
Pierre Neidhardt
dc56dc025d
doc: Discourage the use of texlive as input
...
* doc/contributing.texi (Submitting Patches): Discourage the use of texlive as
input.
2018-12-14 23:32:39 +01:00
Ludovic Courtès
0bc02becca
Remove 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.
2018-12-04 10:57:56 +01:00
Ludovic Courtès
bca6396749
doc: 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.
2018-11-16 23:16:05 +01:00
Pierre Neidhardt
4feb589bf4
doc: Add recommendations for good origin URLs.
...
* doc/contributing.texi (Submitting Patches): URL recommendations.
2018-10-10 18:06:08 +02:00
Arun Isaac
9286c29504
etc: 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.
2018-07-13 12:45:11 +05:30
Ludovic Courtès
0207768fc9
doc: Mention the build environment.
...
* doc/contributing.texi (Running Guix Before It Is Installed): Add a
note about having the dependencies available.
2018-07-04 14:36:07 +02:00
Marius Bakke
38ab778fbd
doc: Clarify when branches are "frozen".
...
* doc/contributing.texi (Submitting Patches): Provide a link to Hydra. Add
section about freezing branches.
2018-06-16 21:35:24 +02:00
Ludovic Courtès
75e24d7b0e
pull: 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.
2018-06-09 12:02:27 +02:00
Ludovic Courtès
60912a888d
doc: Add tips for Vim users.
...
* doc/contributing.texi (Formatting Code): Add a paragraph about Vim.
2018-04-27 18:45:02 +02:00
Ludovic Courtès
67441b9a6e
doc: 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'.
2018-01-17 15:48:22 -08:00
Ricardo Wurmus
42cdcdff19
etc: 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.
2017-12-15 23:15:32 +01:00
Ricardo Wurmus
308c08d371
doc: Move paragraph about signature verification to the top.
...
* doc/contributing.texi (Submitting Patches): Remind contributors to verify
cryptographic signatures at the very beginning.
2017-11-08 17:19:45 +01:00
Jan Nieuwenhuizen
4619b59cb4
doc: 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>
2017-09-19 17:17:42 +02:00
