[doc] Update thread information in developer docs #18645

pull jnewbery wants to merge 1 commits into bitcoin:master from jnewbery:2020-04-doc-threads changing 1 files +36 −11
  1. jnewbery commented at 1:59 AM on April 15, 2020: member
    • DumpAddresses thread was removed in #5964
    • Shutdown thread was removed in #5679
    • Add new threads (scheduler, RPC worker, indexer, tor control)
    • Small changes to documentation of other threads
  2. fanquake added the label Docs on Apr 15, 2020
  3. jonasschnelli commented at 7:50 AM on April 15, 2020: contributor

    Thanks. Glad someone takes care of this. Such documentations do quickly outdate. ACK 04c466aaf58cbbf984a37dafe40bcc634b460f37

  4. hebasto commented at 11:08 AM on April 15, 2020: member

    Concept ACK.

    Maybe add thread names that are available via tools like ps or top: Screenshot from 2020-04-15 14-05-19 ?

  5. in doc/developer-notes.md:431 in 04c466aaf5 outdated 
     429 |  
 430 | -- ThreadImport : Loads blocks from `blk*.dat` files or `-loadblock=<file>`.
 431 | +- ThreadImport : Loads blocks from `blk*.dat` files or `-loadblock=<file>` on startup.
 432 |  
 433 | -- ThreadDNSAddressSeed : Loads addresses of peers from the DNS.
 434 | +- ThreadScriptCheck : Parallel script validation threads for transactions in blocks.
    MarcoFalke commented at 11:48 AM on April 15, 2020: 
    - [`ThreadScriptCheck`](https://doxygen.bitcoincore.org/validation_8cpp.html#a925a33e7952a157922b0bbb8dab29a20) : Parallel script validation threads for transactions in blocks.

    What about adding links to the thread, so that when it is removed in the future, it will be immediately clear from the dead link?

  6. jnewbery force-pushed on Apr 15, 2020
  7. jnewbery commented at 1:51 PM on April 15, 2020: member

    Maybe add thread names that are available via tools like ps or top:

    Done

    What about adding links to the thread, so that when it is removed in the future, it will be immediately clear from the dead link?

    Done

  9. in doc/developer-notes.md:436 in c91fba7f60 outdated 
     435 | -- ThreadDNSAddressSeed : Loads addresses of peers from the DNS.
 436 | +- [ThreadScriptCheck (`b-scriptch.x`)](https://doxygen.bitcoincore.org/validation_8cpp.html#a925a33e7952a157922b0bbb8dab29a20)
 437 | +  : Parallel script validation threads for transactions in blocks.
 438 |  
 439 | -- ThreadMapPort : Universal plug-and-play startup/shutdown.
 440 | +- [ThreadHTTP (`b-http`)](https://doxygen.bitcoincore.org/init_8cpp.html#ae9e290a0e829ec0198518de2eda579d1)
    MarcoFalke commented at 2:14 PM on April 15, 2020: 
    - [ThreadHTTP (`b-http`)](https://doxygen.bitcoincore.org/httpserver_8cpp.html#abb9f6ea8819672bd9a62d3695070709c)
  10. in doc/developer-notes.md:454 in c91fba7f60 outdated 
     459 |  
 460 | -- DumpAddresses : Dumps IP addresses of nodes to `peers.dat`.
 461 | +- Net threads:
 462 |  
 463 | -- ThreadRPCServer : Remote procedure call handler, listens on port 8332 for connections and services them.
 464 | +  - [ThreadMessageHandler (`b-msghand`)](https://doxygen.bitcoincore.org/class_c_connman.html#a765597cbfe99c083d8fa3d61bb464e34)
    MarcoFalke commented at 2:15 PM on April 15, 2020: 
      - [ThreadMessageHandler (`b-msghand`)](https://doxygen.bitcoincore.org/class_c_connman.html#aacdbb7148575a31bb33bc345e2bf22a9)
  11. in doc/developer-notes.md:464 in c91fba7f60 outdated 
     470 | +    : Loads addresses of peers from the DNS.
 471 | +
 472 | +  - [ThreadMapPort (`b-upnp`)](https://doxygen.bitcoincore.org/net_8cpp.html#a63f82a71c4169290c2db1651a9bbe249)
 473 | +    : Universal plug-and-play startup/shutdown.
 474 | +
 475 | +  - [ThreadSocketHandler (`p-net`)](https://doxygen.bitcoincore.org/class_c_connman.html#a132f9cbde795f124c4e146a8ecacd1b3)
    MarcoFalke commented at 2:16 PM on April 15, 2020: 
      - [ThreadSocketHandler (`p-net`)](https://doxygen.bitcoincore.org/class_c_connman.html#a765597cbfe99c083d8fa3d61bb464e34)
  12. MarcoFalke commented at 2:48 PM on April 15, 2020: member

    ACK c91fba7f60b129387fe7ccabb93f28601de80e68 , except for the wrong links

  13. jnewbery force-pushed on Apr 15, 2020
  14. jnewbery commented at 2:57 PM on April 15, 2020: member

    Thanks @MarcoFalke. I've taken your changes.

  15. MarcoFalke commented at 2:58 PM on April 15, 2020: member

    ACK 66e67cfae16fd9154514b5d72888ceb49d52f390 only clicked the links, didn't read the comments

  16. in doc/developer-notes.md:464 in 66e67cfae1 outdated 
     470 | +    : Loads addresses of peers from the DNS.
 471 | +
 472 | +  - [ThreadMapPort (`b-upnp`)](https://doxygen.bitcoincore.org/net_8cpp.html#a63f82a71c4169290c2db1651a9bbe249)
 473 | +    : Universal plug-and-play startup/shutdown.
 474 | +
 475 | +  - [ThreadSocketHandler (`p-net`)](https://doxygen.bitcoincore.org/class_c_connman.html#a765597cbfe99c083d8fa3d61bb464e34)
    hebasto commented at 3:11 PM on April 15, 2020:

    typo: s/p-net/b-net/

    jnewbery commented at 4:02 PM on April 15, 2020:

    fixed

  17. in doc/developer-notes.md:427 in 66e67cfae1 outdated 
     422 | @@ -423,27 +423,52 @@ and its `cs_KeyStore` lock for example).
 423 |  Threads
 424 |  -------
 425 |  
 426 | -- ThreadScriptCheck : Verifies block scripts.
 427 | +- [Main thread (`bitcoind`)](https://doxygen.bitcoincore.org/bitcoind_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97)
 428 | +  : Started from main() in bitcoind.cpp. Responsible for starting up and
    hebasto commented at 3:12 PM on April 15, 2020:

    nit:

      : Started from `main()` in `bitcoind.cpp`. Responsible for starting up and
    jnewbery commented at 4:02 PM on April 15, 2020:

    fixed

  18. [doc] Update thread information in developer docs 808ef36b89
  19. jnewbery force-pushed on Apr 15, 2020
  20. jnewbery commented at 4:03 PM on April 15, 2020: member

    Thanks for the review @hebasto . I've fixed your review comments.

  21. hebasto approved
  22. hebasto commented at 4:05 PM on April 15, 2020: member

    ACK 808ef36b89ea9ce72116bbd7ee479b984367dc60.

  23. MarcoFalke commented at 4:54 PM on April 15, 2020: member

    ACK 808ef36b89

  24. MarcoFalke merged this on Apr 15, 2020
  25. MarcoFalke closed this on Apr 15, 2020
  26. jnewbery deleted the branch on Apr 15, 2020
  27. in doc/developer-notes.md:455 in 808ef36b89 
     460 | -- DumpAddresses : Dumps IP addresses of nodes to `peers.dat`.
 461 | +- Net threads:
 462 |  
 463 | -- ThreadRPCServer : Remote procedure call handler, listens on port 8332 for connections and services them.
 464 | +  - [ThreadMessageHandler (`b-msghand`)](https://doxygen.bitcoincore.org/class_c_connman.html#aacdbb7148575a31bb33bc345e2bf22a9)
 465 | +    : Application level message handling (sending and receiving). Almost
    jonatack commented at 9:14 PM on April 15, 2020:

    s/Application level/Application-level/

  28. in doc/developer-notes.md:465 in 808ef36b89 
     471 | +
 472 | +  - [ThreadMapPort (`b-upnp`)](https://doxygen.bitcoincore.org/net_8cpp.html#a63f82a71c4169290c2db1651a9bbe249)
 473 | +    : Universal plug-and-play startup/shutdown.
 474 | +
 475 | +  - [ThreadSocketHandler (`b-net`)](https://doxygen.bitcoincore.org/class_c_connman.html#a765597cbfe99c083d8fa3d61bb464e34)
 476 | +    : Sends/Receives data from peers on port 8333.
    jonatack commented at 9:15 PM on April 15, 2020:

    s/Receives/receives/

  29. jonatack commented at 9:15 PM on April 15, 2020: member

    ACK. Nice idea to add the doxygen links.

  30. sidhujag referenced this in commit 5d8334f126 on Apr 16, 2020
  31. Fabcien referenced this in commit 5a31841163 on Jan 15, 2021
  32. DrahtBot locked this on Feb 15, 2022
Contributors
jnewberyjonasschnellihebastoMarcoFalkejamesobjonatack
Labels
Docs
Linked (view graph)
#5679 Get rid of DetectShutdownThread#5964 Lightweight task scheduler
github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-13 21:14 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me