Page MenuHomePhabricator

Add build config for documentation, including RPC docs
ClosedPublic

Authored by jasonbcox on Jul 20 2020, 16:51.

Details

Summary

Building documentation should not rely on tests passing in some other
build. This patch splits out docs so they can be reliably built and adds
generating RPC docs to the mix.

Test Plan
build-configurations.py build-docs
ls <build-dir>/artifacts/doc         # verify all doc files are generated correctly

Event Timeline

Fabien requested changes to this revision.Jul 20 2020, 22:23
Fabien added a subscriber: Fabien.
Fabien added inline comments.
contrib/teamcity/builds/build-docs.sh
11

You should build bitcoin-cli at the same time to get more parallel builds

21

You can run bitcoin-cli help until it returns with success (or timeout), that would be less brittle

This revision now requires changes to proceed.Jul 20 2020, 22:23
  • Add bitcoin-cli for better parallelism
  • Make waiting for bitcoind more robust
Fabien added inline comments.
contrib/teamcity/builds/build-docs.sh
25 ↗(On Diff #22394)

Just test the command:

if ./src/bitcoin-cli -regtest help > /dev/null; then
  READY="yes"
  break
fi

To get rid of the shellcheck warning

This revision is now accepted and ready to land.Jul 21 2020, 09:40

Simplify waiting for bitcoind