Add dev tooling #22
Merged
Add dev tooling #22
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a Perl script that creates the rustdocs for a version specific module it `types` e.g., `types/src/v17/mod.rs`.
tcharding
force-pushed
the
12-05-add-verify-tool
branch
from
a1e4ee1 to
5edaa24
Compare
Add a tool to help verify that what we have done is correct.
Adds crate that when run produces:
```bash
Verifying support for Bitcoin Core v17
Checking he documented methods are correct for this version of Core ... ✓
The documented status is correct ... ✓
```
Run the tool for v17 module and fix the few mistakes it found - WIN!
Then fix up the docs in v18 and run the tool to verify the v18 stuff
is correct.
tcharding
force-pushed
the
12-05-add-verify-tool
branch
from
5edaa24 to
4fdea9c
Compare
|
Ugh, I clicked merge instead of ack'ing and using the merge script. |
|
Just crossed my mind that you have been gracious in helping me out with this crate @apoelstra, I merged this to save you the time/effort of looking at it. Didn't mean to brush you. I figured its easier to just pull master and play with the |
|
Yeah, no problem. I don't want to hold you up with process. But if I see stuff that's open I'll probably take a quick look and run through my local CI. |
|
This PR broke Cargo-minimal.lock (and maybe the other one) by adding the MSRV-incompatible |
|
Oh I should have excluded it from the workspace, woops. How did that pass CI I wonder. |
|
Fixed in #35 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add two new tools
types/src/v17/mod.rsverifytool that parses the RPC text file and then greps the codebase doing various checks.The
verifytool is so that one can look at the docs for version specific types (the list of method names and implementation status) and have confidence that they are correct.I'm going to merge and release this without review because its just an additional unreleased dev tool. The fixes included in this PR are what I wanted to have confidence in the next release.
The next thing I want to verify is that the methods documented as returning nothing or stdlib types really do so by either hitting Core or grepping the source ... one day.