doc: Rework guix docs after 1.4 release #28962

pull maflcko wants to merge 1 commits into bitcoin:master from maflcko:2311-doc-guix- changing 2 files +63 −108
  1. maflcko commented at 8:11 PM on November 28, 2023: member
  2. DrahtBot commented at 8:11 PM on November 28, 2023: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    <!--006a51241073e994b41acfe9ec718e94-->

    Code Coverage

    For detailed information about the code coverage, see the test coverage report.

    <!--021abf342d371248e50ceaed478a90ca-->

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK TheCharlatan, fanquake

    If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

  3. DrahtBot added the label Docs on Nov 28, 2023
  4. in contrib/guix/INSTALL.md:66 in fae77949cb outdated
      61 | @@ -62,9 +62,6 @@ so you should log out and log back in.
      62 |  Please refer to fanquake's instructions
      63 |  [here](https://github.com/fanquake/core-review/tree/master/guix).
      64 |  
      65 | -Note that the `Dockerfile` is largely equivalent to running through the binary
      66 | -tarball installation steps.
    


    maflcko commented at 8:11 PM on November 28, 2023:

    review note: There are two Dockerfiles, with different installation methods

  5. maflcko force-pushed on Nov 28, 2023
  6. maflcko force-pushed on Nov 28, 2023
  7. in contrib/guix/INSTALL.md:172 in fa31bfa921 outdated
     153 | @@ -167,80 +154,41 @@ For reference, the graphic below outlines Guix v1.3.0's dependency graph:
     154 |  
     155 |  ![bootstrap map](https://user-images.githubusercontent.com/6399679/125064185-a9a59880-e0b0-11eb-82c1-9b8e5dc9950d.png)
     156 |  
     157 | -#### Consider /tmp on tmpfs
     158 | -
     159 | -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.
    


    maflcko commented at 8:28 PM on November 28, 2023:

    This was added in commit 9b9991e02693c68061ccd4d6040641e20f934e6c by @Sjors , but I don't understand what the hardware (NVME, SSD) has to do with the filesystem and thus the build errors. Also, this should be worked around already in guix 1.4?

    So I've removed the section.


    Sjors commented at 9:34 AM on November 29, 2023:

    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.


    maflcko commented at 9:43 AM on November 29, 2023:

    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.


    maflcko commented at 9:45 AM on November 29, 2023:

    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

  8. maflcko force-pushed on Nov 28, 2023
  9. maflcko force-pushed on Nov 28, 2023
  10. fanquake commented at 11:33 AM on November 29, 2023: member

    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.

  11. in contrib/guix/INSTALL.md:158 in fa25e912f8 outdated
     177 | -
     178 | -###### Example: Checking that Ubuntu's `guile-git` is compatible with your chosen Guile version
     179 | -
     180 | -On Ubuntu Focal:
     181 | +If you do not care about building each dependency from source, and Guix is
     182 | +already packages for your distribution, you can easily install only the build
    


    TheCharlatan commented at 1:27 PM on December 16, 2023:

    s/packages/packaged/


    maflcko commented at 10:51 AM on December 18, 2023:

    thx, done

  12. in contrib/guix/INSTALL.md:714 in fa25e912f8 outdated
     712 | @@ -786,14 +713,44 @@ Basically:
     713 |  6. Turn NTP back on
     714 |  7. Turn networking back on
    


    TheCharlatan commented at 1:43 PM on December 16, 2023:

    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.


    maflcko commented at 10:51 AM on December 18, 2023:

    thx, removed

  13. doc: Rework guix docs after 1.4 release fad444f6e1
  14. maflcko force-pushed on Dec 18, 2023
  15. TheCharlatan approved
  16. TheCharlatan commented at 4:46 PM on January 3, 2024: contributor

    ACK fad444f6e1b1ce5c1572c773db4a9a098c7a0b96

  17. DrahtBot requested review from fanquake on Jan 3, 2024
  18. fanquake approved
  19. fanquake commented at 5:44 PM on January 5, 2024: member

    ACK fad444f6e1b1ce5c1572c773db4a9a098c7a0b96

  20. fanquake merged this on Jan 5, 2024
  21. fanquake closed this on Jan 5, 2024

  22. maflcko deleted the branch on Jan 5, 2024
  23. Fabcien referenced this in commit 36ac73846d on Feb 22, 2024
  24. PastaPastaPasta referenced this in commit 69f110d484 on Oct 24, 2024
  25. PastaPastaPasta referenced this in commit 1406d01bd7 on Oct 24, 2024
  26. PastaPastaPasta referenced this in commit 97012ea522 on Oct 24, 2024
  27. PastaPastaPasta referenced this in commit a67319351a on Oct 24, 2024
  28. bitcoin locked this on Jan 4, 2025

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-22 18:13 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me