Guix documentation improvements #26335

pull Sjors wants to merge 6 commits into bitcoin:master from Sjors:2022/10/guix-doc changing 2 files +62 −53

Sjors commented at 4:14 PM on October 18, 2022: member
I'm manually installing Guix on a fresh Ubuntu machine. Will be pushing more documentation fixes to this PR as I run into things.
1. Bump minimum hash to match time-machine bump in #25099. It's not necessary for the root Guix version to match the time-machine version in our build, because guix build will automatically perform an upgrade for the user, but imo it's better to get any build issues (in Guix itself) over with while the user is going though INSTALL.md, rather than during their first Guix build (of Bitcoin Core).
2. Recommend mapping a tmpfs to /tmp upfront, rather than in the troubleshooting section
3. Add guile-gnutls and guile-json to the table of stuff to install (avoids having to find out in the ./configure phase)
4. Improve systemd doc
5. Workaround OpenSSL v1.1.1l and v1.1.1n test failure (change machine time)
6. Move uninstallation instructions to INSTALL.md, drop unused footnote / links
Sjors force-pushed on Oct 18, 2022

in contrib/guix/INSTALL.md:172 in 1aa4182f4d outdated

 166 | @@ -167,6 +167,10 @@ For reference, the graphic below outlines Guix v1.3.0's dependency graph:
 167 |  
 168 |  ![bootstrap map](https://user-images.githubusercontent.com/6399679/125064185-a9a59880-e0b0-11eb-82c1-9b8e5dc9950d.png)
 169 |  
 170 | +#### Consider /tmp on tmpfs
 171 | +
 172 | +If you use an NVME (SDD) drive, you may encounter [cryptic build errors](https://issues.guix.gnu.org/49985#5). Mounting a [tmpfs at /tmp](https://ubuntu.com/blog/data-driven-analysis-tmp-on-tmpfs) should prevent this and may improve performance as a bonus.

sipa commented at 7:18 PM on October 18, 2022:

SSD?

Sjors force-pushed on Oct 18, 2022
fanquake added the label Docs on Oct 19, 2022
Sjors force-pushed on Oct 19, 2022
Sjors force-pushed on Oct 21, 2022
Sjors commented at 7:36 AM on October 21, 2022: member

I dropped the last commit eba538c15da5278ecacde69256d07320b7eb94ff that bumps the time machine hash (in the documentation). See #26351.
Sjors force-pushed on Oct 21, 2022

guix: bump recommended hash for manual installation

Tracks time-machine bump in 298389e3b51edf561a2b636df0948a232167693a.

682283445e

Sjors force-pushed on Oct 21, 2022

guix: recommend mounting a tmpfs on /tmp

This was already suggested in the troubleshooting section, but recommending it upfront would prevent the issue in the first place and speed up builds.

9b9991e026

guix: add guile-gnutls and guile-json to install list

They are mentioned in the figure above, but having them in the table makes it easier to (apt) install everything required.

8aa460cd02

guix: reminder to migrate guix-daemon-original customization d612dca852
guix: OpenSSL test failure workaround
Co-Authored-By: Stephan Oeste <emzy@emzy.de>
68fab72a8c
Sjors force-pushed on Nov 3, 2022
Sjors marked this as ready for review on Nov 3, 2022
Sjors commented at 11:54 AM on November 3, 2022: member

The current commits are enough for me to build Guix itself from source as root.
doc: move Guix uninstall instructions to INSTALL.md
Also drop unused links.
10660c0c60
jamesob commented at 2:34 PM on November 3, 2022: member

ACK https://github.com/bitcoin/bitcoin/pull/26335/commits/10660c0c60f651a52ba9c86c7dba4fa232ed6583

Haven't followed the purge directions, but this all seems like a strict improvement.
fanquake merged this on Nov 25, 2022
fanquake closed this on Nov 25, 2022
sidhujag referenced this in commit ffc01ea1f2 on Nov 25, 2022
Sjors deleted the branch on Nov 25, 2022
kwvg referenced this in commit 5a7c3a43c8 on Apr 28, 2023
bitcoin locked this on Nov 25, 2023

Contributors

Labels

Linked (view graph)

#25099 guix: bump time-machine to 998eda3067c7d21e0d9bb3310d2f5a14b8f1c681 #26351 guix: bump time-machine to 39dcbc7fa3c02ff5c9682f25e1c29667dbfe7827