Page MenuHomePhabricator

[DOC] Fix various doc issues, improve the linter accordingly
ClosedPublic

Authored by Fabien on Sep 14 2020, 13:10.

Details

Summary

This diff fixes a few issues:

  1. An obsolete content in the developer notes
  2. An invalid anchor in the Qt README
  3. Links to obsolete directories in the contrib README

The linter is updated to catch the cases 2 and 3. The link regex is
updated to allow for passing the anchors as well as links to directories
(or files without an extension). The gitian builder directory is
excluded as the README contains links relative to project root (starting
with /) which will raise false positives in our source tree.

Test Plan

Read the docs.

arc lint --everything

Revert the changes to src/qt/README.md and contrib/README.md and run
arc lint. Check the linter finds the issues.

Diff Detail

Repository
rABC Bitcoin ABC
Branch
fix_various_doc
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 12721
Build 25528: Build Diffbuild-clang-10 · build-diff · build-clang-tidy · build-without-wallet
Build 25527: arc lint + arc unit

Event Timeline

Fabien requested review of this revision.Sep 14 2020, 13:10
jasonbcox added a subscriber: jasonbcox.
jasonbcox added inline comments.
arcanist/linter/MarkdownLinter.php
43

Nit: hypens -> hyphens

This revision is now accepted and ready to land.Sep 14 2020, 16:39