doc: improve developer-notes about threads #25565

pull vasild wants to merge 2 commits into bitcoin:master from vasild:doc_threads changing 1 files +7 −4

vasild commented at 1:24 PM on July 7, 2022: contributor

Document i2paccept in doc/developer-notes.md and fix broken URLs to doxygen.bitcoincore.org.
doc: list the I2P accept thread in developer-notes c5cc3f140c
fanquake added the label Docs on Jul 7, 2022
in doc/developer-notes.md:606 in f691338af5 outdated
```
 602 | @@ -603,10 +603,10 @@ Threads
 603 |    : Started from `main()` in `bitcoind.cpp`. Responsible for starting up and
 604 |    shutting down the application.
 605 |  
 606 | -- [ThreadImport (`b-loadblk`)](https://doxygen.bitcoincore.org/init_8cpp.html#ae9e290a0e829ec0198518de2eda579d1)
 607 | +- [ThreadImport (`b-loadblk`)](https://doxygen.bitcoincore.org/namespacenode.html#ab4305679079866f0f420f7dbf278381d)
```
vasild commented at 1:26 PM on July 7, 2022:

These URLs seem to be fragile. What about dropping them altogether and mentioning just the function name in the doc file.

In general, if it is not auto-generated from the source code then it will likely get outdated.

kouloumos commented at 3:24 PM on July 7, 2022:

if this is still true, links are based on the function signature, and those functions have indeed change since the last edit on this doc.

vasild commented at 10:22 AM on July 8, 2022:

ok, so keeping it as is then
vasild commented at 10:24 AM on July 8, 2022: contributor

f691338af5...50d6d6f12d: correct the commit message
vasild force-pushed on Jul 8, 2022

in doc/developer-notes.md:609 in 50d6d6f12d outdated

 602 | @@ -603,10 +603,10 @@ Threads
 603 |    : Started from `main()` in `bitcoind.cpp`. Responsible for starting up and
 604 |    shutting down the application.
 605 |  
 606 | -- [ThreadImport (`b-loadblk`)](https://doxygen.bitcoincore.org/init_8cpp.html#ae9e290a0e829ec0198518de2eda579d1)
 607 | +- [ThreadImport (`b-loadblk`)](https://doxygen.bitcoincore.org/namespacenode.html#ab4305679079866f0f420f7dbf278381d)
 608 |    : Loads blocks from `blk*.dat` files or `-loadblock=<file>` on startup.
 609 |  
 610 | -- [ThreadScriptCheck (`b-scriptch.x`)](https://doxygen.bitcoincore.org/validation_8cpp.html#a925a33e7952a157922b0bbb8dab29a20)
 611 | +- [ThreadScriptCheck (`b-scriptch.x`)](https://doxygen.bitcoincore.org/class_c_check_queue.html#a6e7fa51d3a25e7cb65446d4b50e6a987)

theStack commented at 3:29 PM on July 9, 2022:

nit: the name ThreadScriptCheck doesn't exist anymore in the code-base, should this be just changed to Loop (though this is not very expressive)?

MarcoFalke commented at 7:31 AM on July 11, 2022:

Maybe CCheckQueue::Loop?

vasild commented at 7:57 AM on July 11, 2022:

Changed to CCheckQueue::Loop, thanks!

theStack approved
theStack commented at 3:36 PM on July 9, 2022: contributor

Code-review ACK 50d6d6f12d1494395945a6d94f5362beeced6c66

Checked that a description for the i2paccept thread was added, the ThreadMapPort thread name was corrected (s/b-upnp/b-mapport/) and verified that the doxygen links point to the right location.

doc: update the URLs to thread functions in developer-notes

ThreadMapPort() does not appear on doxygen.bitcoincore.org
because it is inside `#ifdef`.

dc02edcba1

vasild force-pushed on Jul 11, 2022
vasild commented at 7:59 AM on July 11, 2022: contributor

50d6d6f12d...dc02edcba1: fix the name of the function for script validation: change ThreadScriptCheck to CCheckQueue::Loop.
theStack approved
theStack commented at 9:12 AM on July 11, 2022: contributor

re-ACK dc02edcba1dc67f2d49f618a556f127b41bc04b0
MarcoFalke merged this on Jul 12, 2022
MarcoFalke closed this on Jul 12, 2022
vasild deleted the branch on Jul 12, 2022
sidhujag referenced this in commit 8ada944a7a on Jul 12, 2022
bitcoin locked this on Jul 12, 2023

Contributors

Labels