Commit graph

104 commits

Author SHA1 Message Date
Tobias Geerinckx-Rice
1dfc08f7ad
doc: Fix grammar.
* doc/contributing.texi (Package Naming): Fix grammar.
2021-03-10 01:16:07 +01:00
Leo Famulari
58853df8f6
doc: Try again to the improve the branching workflow.
This is a followup to commit 175bea0ca4.

* doc/contributing.texi (Submitting Patches): Distill the workflow to
its essence.
2021-02-13 13:19:15 -05:00
Leo Famulari
175bea0ca4
doc: Try to improve the branching workflow.
* doc/contributing.texi (Submitting Patches): Introduce the use of "-frozen"
branch names.
2021-02-11 16:13:39 -05:00
Hartmut Goebel
784048c27b
doc: Update guidance about Rust package naming.
* doc/contributing.texi (Rust Crates): Explain versions suffix based on
  packages version and Crate "caret" versioning.
2021-01-29 22:51:23 +01:00
Julien Lepiller
2a9784ffa2
doc: Replace TP with Weblate mentions.
* doc/contributing.texi: Replace link to TP with a link to Weblate.
* doc/guix.texi: Replace link to TP with a link to Weblate.
* doc/guix-cookbook.texi: Replace link to TP with a link to Weblate.
2021-01-20 16:16:45 +01:00
Rovanion Luckey
ad911c8321
doc: Running Guix Before It Is Installed: mention ./bootstrap
* doc/contributing.texi (Running Guix Before It Is Installed): Instruct
user to run ./bootstrap before ./configure.

Signed-off-by: Jakub Kądziołka <kuba@kadziolka.net>
2021-01-03 23:35:29 +01:00
Nicolas Goaziou
eea7cc3185
doc: Emacs Packages: Fix typos.
* doc/contributing.texi (Emacs Packages): Fix typo. Also remove spurious white
space, and unnecessary quote.
2020-12-17 10:01:47 +01:00
Maxim Cournoyer
15fba3b13d
doc: Add Emacs packaging guidelines.
* doc/contributing.texi (Emacs Packages): New subsection.
2020-12-17 00:51:49 -05:00
Tobias Geerinckx-Rice
48cccf06ad
doc: Note different texlive-tiny & texline-union natures.
* doc/contributing.texi (Submitting Patches): Add ‘package’ and
‘procedure’.

Inspired-by: Jorge P. de Morais Neto
2020-12-14 19:11:03 +01:00
Ludovic Courtès
f06f569aa2
doc: Link to "Pattern Matching" in Guile.
* doc/contributing.texi (Data Types and Pattern Matching): Link to the
"Pattern Matching" node of the Guile manual.
2020-12-14 12:19:05 +01:00
Maxim Cournoyer
3de898b43c
maint: update-guix-package: Optionally add sources to store.
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-11-12 09:23:27 -05:00
Miguel Ángel Arruga Vivas
ef6596a20c
build: Add GUIX_GIT_KEYRING variable for make authenticate.
* 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-24 17:38:58 +02:00
Ludovic Courtès
93c251818d
doc: More uses of @lisp instead of @example.
* doc/guix.texi (G-Expressions): Use @lisp for 'let-system' example.
* doc/contributing.texi (Synopses and Descriptions): Use @lisp for
second example.
2020-10-20 01:07:46 +02:00
Maxim Cournoyer
5800d2aae2
maint: update-guix-package: Prevent accidentally breaking guix pull.
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-19 14:02:53 -04:00
Ludovic Courtès
9022861dc0
doc: Clarify that guix-daemon doesn't have to be launched from the checkout.
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-08 12:26:56 +02:00
Ludovic Courtès
6f406e5d15
doc: Developers don't need to run "make install" in Guix.
Suggested by Emmanuel Agullo.

* doc/contributing.texi (Building from Git): Mention that running "make
install" is unnecessary.
2020-10-08 12:26:56 +02:00
Greg Hogan
aa9ba865de
doc: Fix broken hyperlinks in the contribution instructions.
* doc/contributing.texi (Packaging Guidelines, Submitting Patches):
Change URLs from relative to absolute links.
2020-09-18 14:33:17 -04:00
Maxim Cournoyer
71e746cc63
doc: Document the use of snippets vs phases.
* doc/contributing.texi (Snippets versus phases): New section.
2020-09-12 02:01:35 -04:00
Joshua Branson
3e9c6ee19d
doc: Improve the instructions regarding guix git authenticate.
* 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-08-27 16:04:12 -04:00
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, 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-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