[Docs] Improve formatting of developer notes #12759

pull eklitzke wants to merge 1 commits into bitcoin:master from eklitzke:developer-notes changing 1 files +66 −28
  1. eklitzke commented at 6:11 PM on March 22, 2018: contributor

    The developer notes file has gotten pretty large and unwieldly. This reorganizes some content, most notably by adding a TOC to the page. Compare how the page looks in my branch vs master.

    I know there's long-term interest in moving a lot of this content to the bitcoin-core/docs repo on GitHub, but this makes things better now.

    The TOC format here is a semi-standard extension to Markdown files that you may have seen on GitHub pages in other projects. The <!-- markdown-toc --> comments used by these tools to know where the TOC starts/ends. The following tools all understand this format:

    I used this TOC extension at a previous job, and my observation is that it's fine if people just edit the TOC manually. It's just text and it's not a huge deal if it gets a little out of sync. It can also be regenerated at any time by anyone with any of these tools.

  2. randolf approved
  3. randolf commented at 6:28 PM on March 22, 2018: contributor

    Adding the Table of Contents is probably the most important improvement to this document.

  4. in doc/developer-notes.md:15 in e440a0926a outdated 
      10 | +    - [Development tips and tricks](#development-tips-and-tricks)
  11 | +        - [Compiling for debugging](#compiling-for-debugging)
  12 | +        - [Compiling for gprof profiling](#compiling-for-gprof-profiling)
  13 | +        - [debug.log](#debuglog)
  14 | +        - [Testnet and Regtest modes](#testnet-and-regtest-modes)
  15 | +        - [DEBUG_LOCKORDER](#debuglockorder)
    MarcoFalke commented at 6:28 PM on March 22, 2018:

    nit: The anchor on the GitHub web view is debug_lockorder not debuglockorder

    eklitzke commented at 3:27 AM on March 28, 2018:

    fixed

  5. MarcoFalke commented at 6:30 PM on March 22, 2018: member

    utACK

  6. practicalswift commented at 6:48 PM on March 22, 2018: contributor

    ACK e440a0926a3af92bf9a3034a01695d652b173728 modulo @MarcoFalke's nit

    Nice cleanup!

  7. fanquake added the label Docs on Mar 22, 2018
  8. in doc/developer-notes.md:194 in e440a0926a outdated 
     193 | @@ -157,7 +194,7 @@ on all categories (and give you a very large debug.log file).
 194 |  The Qt code routes qDebug() output to debug.log under category "qt": run with -debug=qt
    promag commented at 11:20 PM on March 22, 2018:

    qDebug(), -debug=qt.

  9. in doc/developer-notes.md:199 in e440a0926a outdated 
     193 | @@ -157,7 +194,7 @@ on all categories (and give you a very large debug.log file).
 194 |  The Qt code routes qDebug() output to debug.log under category "qt": run with -debug=qt
 195 |  to see it.
 196 |  
 197 | -**testnet and regtest modes**
 198 | +### Testnet and Regtest modes
 199 |  
 200 |  Run with the -testnet option to run with "play bitcoins" on the test network, if you
    promag commented at 11:20 PM on March 22, 2018:

    -testnet.

  10. in doc/developer-notes.md:204 in e440a0926a outdated 
     202 | @@ -166,14 +203,15 @@ If you are testing something that can run on one machine, run with the -regtest
 203 |  In regression test mode, blocks can be created on-demand; see test/functional/ for tests
 204 |  that run in -regtest mode.
    promag commented at 11:21 PM on March 22, 2018:

    -regtest.

  11. in doc/developer-notes.md:203 in e440a0926a outdated 
     202 | @@ -166,14 +203,15 @@ If you are testing something that can run on one machine, run with the -regtest
 203 |  In regression test mode, blocks can be created on-demand; see test/functional/ for tests
    promag commented at 11:24 PM on March 22, 2018:

    Use link [test/functional/](../test/functional/)?

  12. promag commented at 11:28 PM on March 22, 2018: member

    There are a couple of command line arguments and some class/function names that could be wrapped by `, here are some.

    Anyway, ACK e440a09 after fixing @MarcoFalke point.

  13. hkjn commented at 1:36 PM on March 23, 2018: contributor

    ACK e440a09.

    +1 to @MarcoFalke and @promag's suggestions.

  14. jimpo commented at 5:26 PM on March 27, 2018: contributor

    ACK e440a0926a3af92bf9a3034a01695d652b173728

  15. eklitzke force-pushed on Mar 28, 2018
  16. eklitzke commented at 3:31 AM on March 28, 2018: contributor

    Updated to fix suggestions from @MarcoFalke and @promag

  17. eklitzke force-pushed on Mar 28, 2018
  18. eklitzke force-pushed on Mar 28, 2018
  19. eklitzke force-pushed on Mar 28, 2018
  20. jnewbery commented at 3:23 PM on March 28, 2018: member

    ACK e6f09229213cfcfdf16520477bf60152c32f35f3.

    Could do with more clean-up (eg the split between Developer Notes and Developer Guidelines seems rather blurry), but this is a good first step. Better is better.

  21. MarcoFalke commented at 4:17 PM on March 28, 2018: member

    Needs rebase for keystore changes

  22. Improve formatting of developer notes
    Summary of changes:

 * Add a TOC to the page
 * Make tips and tricks section use h3 headings
 * Reformat and clarify some sections
    0bd2ec5484
  23. eklitzke force-pushed on Mar 28, 2018
  24. eklitzke commented at 7:11 PM on March 28, 2018: contributor

    Rebased.

  25. in doc/developer-notes.md:185 in 0bd2ec5484 
     185 |  
 186 | -**compiling for gprof profiling**
 187 | +### Compiling for gprof profiling
 188 |  
 189 | -Run configure with the --enable-gprof option, then make.
 190 | +Run configure with the `--enable-gprof` option, then make.
    meshcollider commented at 12:08 AM on March 29, 2018:

    nit: make?

  27. hkjn commented at 12:06 PM on March 29, 2018: contributor

    Re-ACK 0bd2ec5.

  29. promag commented at 1:39 PM on March 29, 2018: member

    utACK 0bd2ec5.

  30. laanwj merged this on Mar 29, 2018
  31. laanwj closed this on Mar 29, 2018
  32. laanwj referenced this in commit d3908e2cee on Mar 29, 2018
  33. PastaPastaPasta referenced this in commit d4726599e8 on Sep 27, 2020
  34. PastaPastaPasta referenced this in commit 58b71ce436 on Sep 27, 2020
  35. PastaPastaPasta referenced this in commit a461438fd1 on Oct 14, 2020
  36. MarcoFalke locked this on Sep 8, 2021
Contributors
eklitzkerandolfMarcoFalkepracticalswiftpromaghkjnjimpojnewberymeshcolliderfanquake
Labels
Docs
Linked (view graph)
#18380 doc: Remove html comment in PULL_REQUEST_TEMPLATE
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-15 15:15 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me