Page MenuHomePhabricator

Improve documentation for seed list generation
ClosedPublic

Authored by Mengerian on Jan 14 2019, 06:14.

Details

Summary

Documentation referred to Bitcoin Core procedure. Update
to process applicable to Bitcoin ABC

Test Plan

Read to ensure step correspond to what is actually done.

Diff Detail

Repository
rABC Bitcoin ABC
Branch
seed-test
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 4501
Build 7065: Bitcoin ABC Buildbot (legacy)
Build 7064: arc lint + arc unit

Event Timeline

deadalnix requested changes to this revision.Jan 14 2019, 16:56
deadalnix added inline comments.
contrib/seeds/README.md
15

Please don't assume path, especially a relative path. Especially since it is unlikely that someone will run the seeder for 30 days straight on a devbox. Most likely this file is coming from somewhere else.

18

The path will be dependent on one's setup. You should keep the simple filename.

src/seeder/README.md
29

This isn't really the goal of the seeder though. It is to bootstrap new nodes via DNS. What's more important should come first.

32

Please do not write thing assuming directories, especially relative ones.

This revision now requires changes to proceed.Jan 14 2019, 16:56
contrib/seeds/README.md
18

OK. the only issues is that testnet and mainnet seeders generate the same file name. So that makes it confusing to explain in the documentation.

Remove relative paths

Move list generation use of seeder to end of the document,
since it is not the primary purpose of the seeder.

Mengerian retitled this revision from Improve documentation for seed generation to Improve documentation for seed list generation.Jan 16 2019, 18:33

Remove some commands. The commands that I had added to generate seed
lists were too specific and may just add confusion if the lists
come from a long-running DNS seeder such as seed.bitcoinabc.org

This revision is now accepted and ready to land.Jan 17 2019, 00:55
This revision was automatically updated to reflect the committed changes.