Page MenuHomePhabricator
Differential D6979

Add build config for documentation, including RPC docs
ClosedPublic
Actions

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

Details

Reviewers
Fabien
deadalnix
Group Reviewers
Restricted Project
Commits
rABC41e3cc675f40: Add build config for documentation, including RPC docs
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

Diff Detail

Event Timeline

jasonbcox created this revision.Jul 20 2020, 16:51
Herald added a reviewer: Restricted Project. · View Herald TranscriptJul 20 2020, 16:51
jasonbcox requested review of this revision.Jul 20 2020, 16:51
Harbormaster completed remote builds in B12068: Diff 22371.Jul 20 2020, 17:15
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 ↗(On Diff #22371)

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

21 ↗(On Diff #22371)

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
jasonbcox updated this revision to Diff 22394.Jul 21 2020, 02:43
  • Add bitcoin-cli for better parallelism
  • Make waiting for bitcoind more robust
Harbormaster completed remote builds in B12082: Diff 22394.Jul 21 2020, 03:15
deadalnix accepted this revision.Jul 21 2020, 08:44
deadalnix added a subscriber: deadalnix.

likestamp

Fabien accepted this revision.Jul 21 2020, 09:40
Fabien added inline comments.
contrib/teamcity/builds/build-docs.sh
25

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
jasonbcox updated this revision to Diff 22401.Jul 21 2020, 16:26

Simplify waiting for bitcoind

Harbormaster completed remote builds in B12087: Diff 22401.Jul 21 2020, 16:48
Closed by commit rABC41e3cc675f40: Add build config for documentation, including RPC docs (authored by jasonbcox). · Explain WhyJul 21 2020, 17:04
This revision was automatically updated to reflect the committed changes.
jasonbcox added a commit: rABC41e3cc675f40: Add build config for documentation, including RPC docs.

Revision Contents
Changeset List

PathSize
contrib/
teamcity/
15 lines
builds/
38 lines

Diff 22394

View Options

contrib/teamcity/build-configurations.json

Loading...
View Options

contrib/teamcity/builds/build-docs.sh

Loading...