doc: Rework guix docs after 1.4 release #28962
Conversation
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. Code CoverageFor detailed information about the code coverage, see the test coverage report. ReviewsSee the guideline for information on the review process.
If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update. |
| @@ -62,9 +62,6 @@ so you should log out and log back in. | |||
| Please refer to fanquake's instructions | |||
| [here](https://github.com/fanquake/core-review/tree/master/guix). | |||
|
|
|||
| Note that the `Dockerfile` is largely equivalent to running through the binary | |||
| tarball installation steps. | |||
There was a problem hiding this comment.
review note: There are two Dockerfiles, with different installation methods
fa351e7 to
fa31bfa
Compare
| @@ -167,80 +154,41 @@ For reference, the graphic below outlines Guix v1.3.0's dependency graph: | |||
|
|
|||
|  | |||
|
|
|||
| #### Consider /tmp on tmpfs | |||
|
|
|||
| If you use an NVME (SSD) drive, you may encounter [cryptic build errors](#coreutils-fail-teststail-2inotify-dir-recreate). 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. | |||
There was a problem hiding this comment.
It took a lot of debugging cryptic errors with the help of @dongcarl to figure out that the error I was running into was to due to trying to build guix on a physical SSD drive. It's also just faster to use a RAM drive.
I suppose I could try building guix from scratch without this to see if it's still an issue.
There was a problem hiding this comment.
It's also just faster to use a RAM drive.
Seems fine, but I think it may be better to limit the document here on how to install Guix, not which trade-offs a tmpfs comes with, and instructions to change the partition layout of the running system. This seems more like something that should come with your operating system's installer, no? Happy to add it back, though.
was to due to trying to build guix on a physical SSD drive
Again, I am surprised to see that the metal matters here, as opposed to the filesystem. Also, I'd be surprised if anyone ever built guix on a spinning disk, as they aren't shipped by default for some years now in new hardware. So if this is really due to the SSD, it would be good to add more context, instead of just a recommendation to change the system partition layout.
There was a problem hiding this comment.
In any case, if this was meant as a workaround for https://git.savannah.gnu.org/cgit/guix.git/commit/?id=6ba1058df0c4ce5611c2367531ae5c3cdc729ab4, that commit is in guix v1.4
fa37e74 to
fa25e91
Compare
|
Concept ACK - seems fine to drop most of the workarounds / guile 2 vs 3 docs, as anyone building from scratch at this point, should be building 1.4.0 or master. |
contrib/guix/INSTALL.md
Outdated
|
|
||
| On Ubuntu Focal: | ||
| If you do not care about building each dependency from source, and Guix is | ||
| already packages for your distribution, you can easily install only the build |
contrib/guix/INSTALL.md
Outdated
| @@ -786,14 +713,44 @@ Basically: | |||
| 6. Turn NTP back on | |||
| 7. Turn networking back on | |||
There was a problem hiding this comment.
Not really related to this patch, but why is this suggesting to turn networking on and off? Seems like an efficient way to lock yourself out of a box.
fa25e91 to
fad444f
Compare
Summary: This is a backport of [[bitcoin/bitcoin#28902 | core#28902]] and [[bitcoin/bitcoin#28962 | core#28962]] Test Plan: proof-reading Reviewers: #bitcoin_abc, Fabien Reviewed By: #bitcoin_abc, Fabien Subscribers: Fabien Differential Revision: https://reviews.bitcoinabc.org/D15504
fad444f doc: Rework guix docs after 1.4 release (MarcoFalke) Pull request description: Follow-up to bitcoin#28902 Fixes bitcoin#28957 ACKs for top commit: TheCharlatan: ACK fad444f fanquake: ACK fad444f Tree-SHA512: 23f270b438ede4e3173da68e63c1d022e2ef23bfd83f0ec038ec63a62348038722278385c5dac63ac29a460b4b61f23d8c9939667e00a1a3571b041d3eecb4cb
fad444f doc: Rework guix docs after 1.4 release (MarcoFalke) Pull request description: Follow-up to bitcoin#28902 Fixes bitcoin#28957 ACKs for top commit: TheCharlatan: ACK fad444f fanquake: ACK fad444f Tree-SHA512: 23f270b438ede4e3173da68e63c1d022e2ef23bfd83f0ec038ec63a62348038722278385c5dac63ac29a460b4b61f23d8c9939667e00a1a3571b041d3eecb4cb
fad444f doc: Rework guix docs after 1.4 release (MarcoFalke) Pull request description: Follow-up to bitcoin#28902 Fixes bitcoin#28957 ACKs for top commit: TheCharlatan: ACK fad444f fanquake: ACK fad444f Tree-SHA512: 23f270b438ede4e3173da68e63c1d022e2ef23bfd83f0ec038ec63a62348038722278385c5dac63ac29a460b4b61f23d8c9939667e00a1a3571b041d3eecb4cb
8bf1d06 Merge bitcoin#29308: doc: update `BroadcastTransaction` comment (glozow) 2a77808 Merge bitcoin-core/gui#789: Avoid non-self-contained Windows header (Hennadii Stepanov) da371b8 Merge bitcoin#28870: depends: Include `config.guess` and `config.sub` into `meta_depends` (fanquake) 2e41562 Merge bitcoin#29219: fuzz: Improve fuzzing stability for ellswift_roundtrip harness (fanquake) b091329 Merge bitcoin#29211: fuzz: fix `connman` initialization (Ava Chow) df42d41 Merge bitcoin#29200: net: create I2P sessions using both ECIES-X25519 and ElGamal encryption (fanquake) 4cdd1a8 Merge bitcoin#29172: fuzz: set `nMaxOutboundLimit` in connman target (fanquake) 97012ea Merge bitcoin#28962: doc: Rework guix docs after 1.4 release (fanquake) c70ff5d Merge bitcoin#28844: contrib: drop GCC MAX_VERSION to 4.3.0 in symbol-check (fanquake) e6f19e7 Merge bitcoin#29068: test: Actually fail when a python unit test fails (fanquake) 75e0334 Merge bitcoin#28989: test: Fix test by checking the actual exception instance (Andrew Chow) 8cd85d3 Merge bitcoin#28852: script, assumeutxo: Enhance validations in utxo_snapshot.sh (Ryan Ofsky) fd2e88d Merge bitcoin#26077: guix: switch from `guix environment` to `guix shell` (fanquake) 02741a7 Merge bitcoin#28913: coins: make sure PoolAllocator uses the correct alignment (fanquake) dfd53da Merge bitcoin#28902: doc: Simplify guix install doc, after 1.4 release (fanquake) Pull request description: ## Issue being fixed or feature implemented Batch of trivial backports ## What was done? See commits ## How Has This Been Tested? built locally; large combined merge passed tests locally ## Breaking Changes Should be none ## Checklist: _Go over all the following points, and put an `x` in all the boxes that apply._ - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have added or updated relevant unit/integration/functional/e2e tests - [ ] I have made corresponding changes to the documentation - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_ ACKs for top commit: UdjinM6: utACK 8bf1d06 knst: utACK 8bf1d06 Tree-SHA512: 506273e5a188f9ca74edf656e3cd338992192e6e97f68c89fc43e34be20fb7f211b48e4dfa8693727839a7920da8284509413c722f55774a428939c296dad517
Follow-up to #28902
Fixes #28957