The previous instructions were correct, but we got too many bug reports
with a root cause of "did not build Guix yet".
Other parts of the manual already instruct `make && make check`, so this
makes the treatment of building Guix more consistent, too.
* doc/contributing.texi (Building from Git): Instruct the user to run
`make` when building Guix.
2021-04-04 13:34:30 -04:00
Tobias Geerinckx-Rice via Bug reports for GNU Guix
For more context, see the discussion in <https://bugs.gnu.org/47111>.
* doc/contributing.texi (Commit Access): Add paragraph about removing
inactive committers.
Fixes <https://issues.guix.gnu.org/36117>.
Before this change, the 'binfmt_misc' entries registered for QEMU would not be
usable in container contexts outside of guix-daemon (without manually bind
mounting file names).
For example:
$ docker run --rm arm32v7/debian true
standard_init_linux.go:207: exec user process caused "no such file or directory"
After this change, any container can make use of the QEMU binfmt_misc
registrations, as their corresponding QEMU static binaries are fully
pre-loaded by the kernel.
* gnu/services/virtualization.scm (<qemu-platform>): Define using
'define-record-type*'.
[flags]: New field, which defaults to "F" (fix binary).
(%i386, %i486, %alpha, %arm, %armeb, %sparc, %sparc32plus, %ppc, %ppc64)
(%ppc64le, %m68k, %mips, %mipsel, %mipsn32, %mipsn32el, %mips64, %mips64el)
(%riscv32, %riscv64, %sh4, %sh4eb, %s390x, %aarch64, %hppa): Adjust.
(qemu-binfmt-guix-chroot): Remove variable.
(qemu-binfmt-service-type): Remove the qemu-binfmt-guix-chroot extension.
* gnu/services/qemu-binfmt (qemu-platform->binfmt): Use the static output of
QEMU.
* doc/contributing.texi (Submitting Patches): Update doc.
* doc/guix.texi (Virtualization Services): Update doc.
* 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.
* 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>
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>
* 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.
* doc/guix.texi (G-Expressions): Use @lisp for 'let-system' example.
* doc/contributing.texi (Synopses and Descriptions): Use @lisp for
second example.
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.
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.
* 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>
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.
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.
* 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>
* 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.
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.
* 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>
* 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>
Suggested by swedebugia <swedebugia@riseup.net>.
* doc/contributing.texi (Running Guix Before It Is Installed): Mention
that ./pre-inst-env is generated.
* 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.
* 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>
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.
* doc/htmlxref.cnf: Add links to the real manual.
* doc/contributing.texi (Formatting Code): Add reference to it.
* doc/guix.texi (Package Management): Likewise.
* 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>
* 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>
* 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>
* emacs/guix-guile.el (guix-guile-current-module): New function.
* emacs/guix-devel.el: New file.
* emacs.am (ELFILES): Add it.
* doc/emacs.texi (Emacs Development): New node.
(Emacs Interface): Add it.
* doc/contributing.texi (The Perfect Setup): Mention it.
* doc/guix.texi (Top): Add it.
* emacs/guix-init.el: Add 'guix-devel-activate-mode-maybe' to
'scheme-mode-hook'.
* guix/scripts/size.scm: New file.
* Makefile.am (MODULES): Add it.
(SCM_TESTS): Add tests/size.scm.
* doc.am (SUBCOMMANDS): Add 'size'.
* po/guix/POTFILES.in: Add guix/scripts/size.scm.
* tests/size.scm: New file.
* doc/guix.texi (Packages with Multiple Outputs): Add xref to "Invoking guix
size".
(Invoking guix size): New node.
(Invoking guix gc): Add index for "closure" and xref to the above.
* doc/contributing.texi (Submitting Patches): Use @enumerate for the check
list. Add item about 'guix size'.
* HACKING (Contributing): New section.
(Building from Git, The Perfect Setup, Coding Style, Submitting Patches):
Move to ...
* doc/guix.texi (Running Guix Before It Is Installed): Likewise.
* doc/contributing.texi: ... here. New file.
* doc.am (EXTRA_DIST): Use it.
* README (Installation): Adapt to it.
* configure.ac (DOT): Likewise.
Filip Lajszczak
Tobias Geerinckx-Rice
Jelle Licht
Leo Famulari
Julien Lepiller
Tobias Geerinckx-Rice via Bug reports for GNU Guix
Maxim Cournoyer
Hartmut Goebel
Rovanion Luckey
Nicolas Goaziou
Ludovic Courtès
Miguel Ángel Arruga Vivas
Ludovic Courtès
Greg Hogan
Joshua Branson
Marius Bakke
Efraim Flashner
zimoun
Brice Waegeneire
Vitaliy Shatrov
Jakub Kądziołka
Oleg Pykhalov
Pierre Neidhardt
Florian Pelz
Arne Babenhauserheide
Giovanni Biscuolo
Danny Milosavljevic
Arun Isaac
Marius Bakke
Ricardo Wurmus
Jan Nieuwenhuizen
Alex Kost
ng0
Christopher Allan Webber
Chris Marusich
Alex Sassmannshausen
Alex Vong
Mark H Weaver
Mathieu Lirzin