Merge bitcoin/bitcoin#32572: doc: Remove stale sections in dev notes

fac00d4ed3 doc: Move CI-must-pass requirement into readme section (MarcoFalke)
fab79c1a25 doc: Clarify and move "hygienic commit" note (MarcoFalke)
fac8b05197 doc: Clarify strprintf size specifier note (MarcoFalke)
faaf34ad72 doc: Remove section about RPC alias via function pointer (MarcoFalke)
2222d61e1c doc: Remove section about RPC arg names in table (MarcoFalke)
fa00b8c02c doc: Remove section about include guards (MarcoFalke)
fad6cd739b doc: Remove dev note section on includes (MarcoFalke)
fa6623d85a doc: Remove file name section (MarcoFalke)
7777fb8bc7 doc: Remove shebang section (MarcoFalke)
faf65f0531 doc: Remove .gitignore section (MarcoFalke)
faf2094f25 doc: Remove note about removed ParsePrechecks (MarcoFalke)
fa69c5b170 doc: Remove -disablewallet from dev notes (MarcoFalke)

Pull request description:

  This removes sections that I've been collecting as stale or overly redundant over the years. The rationale for each removal is in the commit message.

ACKs for top commit:
  yuvicc:
    ACK fac00d4ed3
  janb84:
    LGTM ACK fac00d4ed3
  glozow:
    ACK fac00d4ed3, all lgtm

Tree-SHA512: 17a5b4277fb30d265959d1230a705b36d8501a64c0f4a7f272ea5d9c22031421f95c491144f6d6f714dc7927df667d96ece9ceb43e0a07317d76fdcc4769aaa7
This commit is contained in:
merge-script
2025-06-10 15:41:11 -04:00
6 changed files with 14 additions and 111 deletions

View File

@@ -26,6 +26,9 @@ ALLOWED_SOURCE_FILENAME_EXCEPTION_REGEXP = (
ALLOWED_PERMISSION_NON_EXECUTABLES = 0o644
ALLOWED_PERMISSION_EXECUTABLES = 0o755
ALLOWED_EXECUTABLE_SHEBANG = {
# https://github.com/dylanaraps/pure-bash-bible#shebang:
# `#!/bin/bash` assumes it is always installed to /bin/ which can cause issues;
# `#!/usr/bin/env bash` searches the user's PATH to find the bash binary.
"py": [b"#!/usr/bin/env python3"],
"sh": [b"#!/usr/bin/env bash", b"#!/bin/sh"],
}

View File

@@ -83,7 +83,7 @@ def main():
if count != 3:
print(f'{header_file} seems to be missing the expected '
'include guard:')
'include guard to prevent the double inclusion problem:')
print(f' #ifndef {header_id}')
print(f' #define {header_id}')
print(' ...')

View File

@@ -166,6 +166,10 @@ def main():
# Enforce bracket syntax includes
quote_syntax_inclusions = find_quote_syntax_inclusions()
# *Rationale*: Bracket syntax is less ambiguous because the preprocessor
# searches a fixed list of include directories without taking location of the
# source file into account. This allows quoted includes to stand out more when
# the location of the source file actually is relevant.
if quote_syntax_inclusions:
print("Please use bracket syntax includes (\"#include <foo.h>\") instead of quote syntax includes:")