Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: various developer notes updates #25092

Merged
merged 5 commits into from
May 16, 2022

Conversation

jonatack
Copy link
Member

@jonatack jonatack commented May 9, 2022

A few updates noticed while working on a lifetimebound section.

  • Remove obsolete BDB ENABLE_WALLET section (only one file, src/wallet/bdb.h, still has a db_cxx.h BDB header)
  • Prefer Python for scripts in developer notes (and a few miscellaneous touch-ups)
  • In the code style section, add a link to the internal interface exception so that people are aware of it
  • Add a "C++ functions and methods" section
  • Add a Clang lifetimebound attribute section

@laanwj laanwj added the Docs label May 9, 2022
doc/developer-notes.md Outdated Show resolved Hide resolved
@laanwj
Copy link
Member

laanwj commented May 9, 2022

Looks good to me.

@jonatack jonatack force-pushed the developer-notes-updates-may-2022 branch from 968a67b to 91d6d4a Compare May 9, 2022 18:13
Copy link
Contributor

@w0xlt w0xlt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 91d6d4a

doc/developer-notes.md Outdated Show resolved Hide resolved
doc/developer-notes.md Outdated Show resolved Hide resolved
@jonatack jonatack force-pushed the developer-notes-updates-may-2022 branch from 91d6d4a to 8d9ca1f Compare May 10, 2022 12:34
doc/developer-notes.md Outdated Show resolved Hide resolved
Credit for some parts to the Google C++ Style Guide "Inputs and Outputs"
section at https://google.github.io/styleguide/cppguide.html#Inputs_and_Outputs

Co-authored-by: laanwj <126646+laanwj@users.noreply.github.com>
@jonatack jonatack force-pushed the developer-notes-updates-may-2022 branch from 8d9ca1f to e66b321 Compare May 10, 2022 13:00
@laanwj
Copy link
Member

laanwj commented May 10, 2022

ACK 6542842

@DrahtBot
Copy link
Contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

  • #24846 (developer-notes: allow lowerCamelCase for methods by jamesob)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

Copy link
Member

@jarolrod jarolrod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code review ACK 6542842

Nice improvements to the dev docs 👍

@maflcko maflcko merged commit bc2eee7 into bitcoin:master May 16, 2022
@jonatack jonatack deleted the developer-notes-updates-may-2022 branch May 16, 2022 08:50
sidhujag pushed a commit to syscoin/syscoin that referenced this pull request May 28, 2022
6542842 Add clang lifetimebound section to developer notes (Jon Atack)
e66b321 Add C++ functions and methods section to developer notes (Jon Atack)
5fca70f Link in developer notes style to internal interface exception (Jon Atack)
fc4cb85 Prefer Python for scripts in developer notes (Jon Atack)
370120e Remove obsolete BDB ENABLE_WALLET section in developer notes (Jon Atack)

Pull request description:

  A few updates noticed while working on a lifetimebound section.

  - Remove obsolete BDB ENABLE_WALLET section (only one file, src/wallet/bdb.h, still has a `db_cxx.h` BDB header)
  - Prefer Python for scripts in developer notes (and a few miscellaneous touch-ups)
  - In the code style section, add a link to the internal interface exception so that people are aware of it
  - Add a "C++ functions and methods" section
  - Add a Clang `lifetimebound` attribute section

ACKs for top commit:
  laanwj:
    ACK 6542842
  jarolrod:
    code review ACK bitcoin@6542842

Tree-SHA512: d2ae335cac899451d5c7bdc8e94fd82053a5f44ac1ba444bdde71abaaa24a519713c1078f3a8f07ec8466b181788a613fd3c68061e54b3fdc8cd6f3e3f9791ec
@bitcoin bitcoin locked and limited conversation to collaborators May 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants