guix: Add full installation and usage documentation #21711
Conversation
|
@dongcarl can you rebase this and address the current batch of comments? |
57684ed to
5ae2760
Compare
|
Pushed 57684ed...5ae2760 |
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsReviewers, this pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first. |
|
Shouldn't this also update |
|
The documentation is very close to being done, just some final polishing and making the links work. Please let me know if I'm missing any crucial details! |
63e8fce to
5016091
Compare
There was a problem hiding this comment.
Concept ACK
Looks pretty good. Maybe a little too much detail in some cases, i.e some things feel a bit repetitive, but I think that's ok for now.
In release-process.md, there are still two mentions of gitian in the Update packaging repo section.
In guix-attest, can you address this comment from #22182.
I am running through doing a build using a Ubuntu:Hirsute container, using the following:
docker run -it --rm --privileged ubuntu:hirsute /bin/bash
apt update -y && apt upgrade -y && apt install curl git guix make -y
addgroup guixbuild
useradd -g guixbuild -G guixbuild -d /var/empty -s $(which nologin) -c "Guix build user" --system "guixbuilder"
guix-daemon --no-substitutes --build-users-group=guixbuild &
git clone https://github.com/bitcoin/bitcoin
cd bitcoin
HOSTS="x86_64-linux-gnu" ./contrib/guix/guix-buildI've also updated my Alpine based dockerfile to use Alpine 3.14, and am currently running through a from-scratch build using that. Using a build invocation like:
time BASE_CACHE="/guix/base_cache" SOURCES_PATH="/guix/sources" SDK_PATH="/guix/SDKs" ./contrib/guix/guix-build.
6a4f6b6 to
d766580
Compare
d766580 to
181ba75
Compare
|
ACK 181ba75 |
- Added detailed Guix bootstrap/installation instructions
That way we can easily combine the document and detached signature to produce cleartext signature files for upload during the release process. See subsequent commits which modify doc/release-process.md for more details.
Also, clean up release-process.md
181ba75 to
fac4814
Compare
There was a problem hiding this comment.
ACK fac4814 - going to go ahead and merge this now. It's a lot of documentation, and could probably be nit-picked / improved further, however, that can continue over the next few weeks. I'm sure more (backportable) improvements / clarifications will be made while we progress through RCs towards a new release.
| <!-- ``` --> | ||
| <!-- apt update --> | ||
| <!-- apt show guile-git --> | ||
| <!-- ``` --> |
| systems to build packages from source will be helpful. *hic sunt dracones.* | ||
|
|
||
| I strongly urge you to at least skim through the entire section once before you | ||
| start issuing commands, as it will save you a lot of unncessary pain and |
There was a problem hiding this comment.
typo: unncessary ==> unnecessary
|
|
||
| For reference, the graphic below outlines Guix v1.3.0's dependency graph: | ||
|
|
||
|  |
Based on: #21462
Keeping the README in one file so that it's easy to search through. Will add more jumping links later so navigation is easier.
Current TODOs:
/etc/profile.dentry to be picked up/etc/profile.dentry and re-loginguix-daemon-latestunit after finishing "optional setup" sectionNote to self: wherever possible, tell user how to check that something is true rather than branching by installation option.