doc: update signet documentation related to build directories #30996

pull torkelrogstad wants to merge 1 commits into bitcoin:master from torkelrogstad:2024-09-28-docs changing 1 files +3 −4
  1. torkelrogstad commented at 6:56 pm on September 28, 2024: contributor
    While setting up my own signet I noticed that the binary paths in the documentation for this is out of date, after build artifacts moved to the build directory. This PR mimics what happened in #30741
  2. doc: update signet documentation related to build directories a647d4400d
  3. DrahtBot commented at 6:56 pm on September 28, 2024: contributor

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

    Code Coverage

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

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK pablomartin4btc, tdb3, maflcko

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

  4. DrahtBot added the label Docs on Sep 28, 2024
  5. pablomartin4btc commented at 4:25 pm on September 30, 2024: member
    ACK a647d4400d55558735f102988e84eedc39b3affa
  6. in contrib/signet/README.md:27 in a647d4400d
    22@@ -23,17 +23,16 @@ miner
    23 
    24 You will first need to pick a difficulty target. Since signet chains are primarily protected by a signature rather than proof of work, there is no need to spend as much energy as possible mining, however you may wish to choose to spend more time than the absolute minimum. The calibrate subcommand can be used to pick a target appropriate for your hardware, eg:
    25 
    26-    cd src/
    27-    MINER="../contrib/signet/miner"
    28-    GRIND="./bitcoin-util grind"
    29+    MINER="./contrib/signet/miner"
    30+    GRIND="./build/src/bitcoin-util grind"
    


    pablomartin4btc commented at 4:26 pm on September 30, 2024:

    nit:

    0    GRIND="./build/src/bitcoin-util grind" #assuming the build directory is named `build`
    

    torkelrogstad commented at 5:15 pm on September 30, 2024:
    This is the build directory used by the unix and macOS build docs. IMO it’s therefore not necessary to mention that here. If people are clever enough to change the build directories they’ll also understand that this changes the location of binaries.

    pablomartin4btc commented at 5:19 pm on September 30, 2024:
    ok, just to be consistent with other places in the documentation where this is clarified.
  7. tdb3 approved
  8. tdb3 commented at 3:58 am on October 12, 2024: contributor
    Code review and light test ACK a647d4400d55558735f102988e84eedc39b3affa
  9. DrahtBot added the label CI failed on Oct 12, 2024
  10. maflcko commented at 3:42 pm on October 16, 2024: member

    lgtm ACK a647d4400d55558735f102988e84eedc39b3affa

    CI failure is unrelated: https://github.com/bitcoin/bitcoin/issues/31103

  11. maflcko added this to the milestone 29.0 on Oct 16, 2024
  12. fanquake merged this on Oct 16, 2024
  13. fanquake closed this on Oct 16, 2024

  14. glitteryskye99 commented at 2:33 am on October 17, 2024: none
    Interesting

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: 2024-11-21 09:12 UTC

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