doc: correct the zmq automatic build info

tdb3 commented at 7:07 pm on September 22, 2024: contributor

The current documentation states that the ZMQ feature is automatically included when building. Noticed this was no longer the case when building to review PR #30942.

DrahtBot commented at 7:07 pm on September 22, 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	hebasto, l0rinc
Stale ACK	fjahr

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

DrahtBot added the label Docs on Sep 22, 2024

tdb3 commented at 7:49 pm on September 22, 2024: contributor

CI failure seems to be another instance of #30922

 0test  2024-09-22T19:16:03.915000Z TestFramework (ERROR): Assertion failed 
 1                                   Traceback (most recent call last):
 2                                     File "/Users/runner/work/bitcoin/bitcoin/test/functional/test_framework/test_framework.py", line 132, in main
 3                                       self.run_test()
 4                                     File "/Users/runner/work/bitcoin/bitcoin/ci/scratch/build-aarch64-apple-darwin23.6.0/test/functional/p2p_1p1c_network.py", line 137, in run_test
 5                                       self.raise_network_minfee()
 6                                     File "/Users/runner/work/bitcoin/bitcoin/ci/scratch/build-aarch64-apple-darwin23.6.0/test/functional/p2p_1p1c_network.py", line 58, in raise_network_minfee
 7                                       assert_greater_than(node.getmempoolinfo()['mempoolminfee'], FEERATE_1SAT_VB)
 8                                     File "/Users/runner/work/bitcoin/bitcoin/test/functional/test_framework/util.py", line 82, in assert_greater_than
 9                                       raise AssertionError("%s <= %s" % (str(thing1), str(thing2)))
10                                   AssertionError: 0.00001000 <= 0.00001000

fjahr commented at 8:51 pm on September 22, 2024: contributor

ACK 858bb0c5285cb713bb1de056135d1331c17c35a9

in doc/zmq.md:52 in 858bb0c528 outdated

51-during the *configure* step of building bitcoind:
52+By default, the ZeroMQ feature is not automatically compiled.
53+To enable, use `-DWITH_ZMQ=ON` when building:
54 
55-    $ cmake -B build -DWITH_ZMQ=OFF (other options)
56+    $ cmake -B build -DWITH_ZMQ=ON (other options)

l0rinc commented at 12:05 pm on September 24, 2024:

I also noticed the same. this line should be executable code, could we either remove (other options) or add it as a comment instead?

tdb3 commented at 11:42 pm on September 24, 2024:

Thanks for taking a look. Decided to remove “(other options)” since it should be pretty clear to readers that the presence of this option wouldn’t preclude the use of other ones needed.

tdb3 force-pushed on Sep 24, 2024

fjahr commented at 10:00 am on September 25, 2024: contributor

ACK e52ccc0203aefdebccd5a2f7146e58a816539467

l0rinc commented at 10:09 am on September 25, 2024: contributor

ACK e52ccc0203aefdebccd5a2f7146e58a816539467

in doc/zmq.md:50 in e52ccc0203 outdated

45@@ -46,11 +46,10 @@ operation.
46 
47 ## Enabling
48 
49-By default, the ZeroMQ feature is automatically compiled in if the
50-necessary prerequisites are found.  To disable, use -DWITH_ZMQ=OFF
51-during the *configure* step of building bitcoind:
52+By default, the ZeroMQ feature is not automatically compiled.
53+To enable, use `-DWITH_ZMQ=ON` when building:

hebasto commented at 11:03 am on September 25, 2024:

pedantic nit: The technically correct term for the first cmake invocation is “generating a project buildsystem”. The actual “building” is performed by the generated build system during the following step. Elsewhere in our documentation, we use phrases such as “configuring Bitcoin Core” or “configuring the build system”.

tdb3 commented at 11:08 am on September 25, 2024:

Yeah, you’re right. I was on the fence about naming (since the actual build is done with cmake --build build -jN). Better to fix it now, so I pushed a change.

hebasto approved

hebasto commented at 11:03 am on September 25, 2024: member

ACK e52ccc0203aefdebccd5a2f7146e58a816539467.

doc: correct the zmq automatic build info 06e7e83632

tdb3 force-pushed on Sep 25, 2024

hebasto approved

hebasto commented at 11:08 am on September 25, 2024: member

re-ACK 06e7e83632985bd8b648d24f9a51591d3a3bbec3.

DrahtBot requested review from fjahr on Sep 25, 2024

DrahtBot requested review from l0rinc on Sep 25, 2024

l0rinc commented at 11:17 am on September 25, 2024: contributor

ACK 06e7e83632985bd8b648d24f9a51591d3a3bbec3

fanquake merged this on Sep 25, 2024

fanquake closed this on Sep 25, 2024

doc: correct the zmq automatic build info #30946

Code Coverage

Reviews