Merge #13312: docs: Add a note about the source code filename naming convention

e56771365b Do not use uppercase characters in source code filenames (practicalswift)
419a1983ca docs: Add a note about the source code filename naming convention (practicalswift)

Pull request description:

  Add a note about the source code filename naming convention.

Tree-SHA512: 8d329bd9e19bcd26e74b0862fb0bc2369b46095dbd3e69d34859908632763abd7c3d00ccc44ee059772ad4bae4460c2bcc1c0e22fd9d8876d57e5fcd346cea4b
This commit is contained in:
MarcoFalke 2018-06-12 08:02:14 -04:00 committed by pasta
parent 6e5b3f3b9e
commit f77b58e89f
7 changed files with 12 additions and 6 deletions

View File

@ -521,6 +521,12 @@ Source code organization
- *Rationale*: Shorter and simpler header files are easier to read, and reduce compile time - *Rationale*: Shorter and simpler header files are easier to read, and reduce compile time
- Use only the lowercase alphanumerics (`a-z0-9`), underscore (`_`) and hyphen (`-`) in source code filenames.
- *Rationale*: `grep`:ing and auto-completing filenames is easier when using a consistent
naming pattern. Potential problems when building on case-insensitive filesystems are
avoided when using only lowercase characters in source code filenames.
- Every `.cpp` and `.h` file should `#include` every header file it directly uses classes, functions or other - Every `.cpp` and `.h` file should `#include` every header file it directly uses classes, functions or other
definitions from, even if those headers are already included indirectly through other headers. One exception definitions from, even if those headers are already included indirectly through other headers. One exception
is that a `.cpp` file does not need to re-include the includes already included in its corresponding `.h` file. is that a `.cpp` file does not need to re-include the includes already included in its corresponding `.h` file.

View File

@ -21,7 +21,7 @@ bench_bench_dash_SOURCES = \
bench/checkblock.cpp \ bench/checkblock.cpp \
bench/checkqueue.cpp \ bench/checkqueue.cpp \
bench/ecdsa.cpp \ bench/ecdsa.cpp \
bench/Examples.cpp \ bench/examples.cpp \
bench/rollingbloom.cpp \ bench/rollingbloom.cpp \
bench/chacha20.cpp \ bench/chacha20.cpp \
bench/chacha_poly_aead.cpp \ bench/chacha_poly_aead.cpp \

View File

@ -51,7 +51,7 @@ BITCOIN_TESTS =\
test/compress_tests.cpp \ test/compress_tests.cpp \
test/crypto_tests.cpp \ test/crypto_tests.cpp \
test/cuckoocache_tests.cpp \ test/cuckoocache_tests.cpp \
test/DoS_tests.cpp \ test/denialofservice_tests.cpp \
test/evo_deterministicmns_tests.cpp \ test/evo_deterministicmns_tests.cpp \
test/evo_simplifiedmns_tests.cpp \ test/evo_simplifiedmns_tests.cpp \
test/getarg_tests.cpp \ test/getarg_tests.cpp \
@ -80,7 +80,7 @@ BITCOIN_TESTS =\
test/rpc_tests.cpp \ test/rpc_tests.cpp \
test/sanity_tests.cpp \ test/sanity_tests.cpp \
test/scheduler_tests.cpp \ test/scheduler_tests.cpp \
test/script_P2SH_tests.cpp \ test/script_p2sh_tests.cpp \
test/script_P2PK_tests.cpp \ test/script_P2PK_tests.cpp \
test/script_P2PKH_tests.cpp \ test/script_P2PKH_tests.cpp \
test/script_tests.cpp \ test/script_tests.cpp \

View File

@ -836,7 +836,7 @@ size_t GetRequestedObjectCount(NodeId nodeId)
} }
// This function is used for testing the stale tip eviction logic, see // This function is used for testing the stale tip eviction logic, see
// DoS_tests.cpp // denialofservice_tests.cpp
void UpdateLastBlockAnnounceTime(NodeId node, int64_t time_in_seconds) void UpdateLastBlockAnnounceTime(NodeId node, int64_t time_in_seconds)
{ {
LOCK(cs_main); LOCK(cs_main);

View File

@ -45,7 +45,7 @@ static NodeId id = 0;
void UpdateLastBlockAnnounceTime(NodeId node, int64_t time_in_seconds); void UpdateLastBlockAnnounceTime(NodeId node, int64_t time_in_seconds);
BOOST_FIXTURE_TEST_SUITE(DoS_tests, TestingSetup) BOOST_FIXTURE_TEST_SUITE(denialofservice_tests, TestingSetup)
// Test eviction of an outbound peer whose chain never advances // Test eviction of an outbound peer whose chain never advances
// Mock a node connection, and use mocktime to simulate a peer // Mock a node connection, and use mocktime to simulate a peer

View File

@ -46,7 +46,7 @@ Verify(const CScript& scriptSig, const CScript& scriptPubKey, bool fStrict, Scri
} }
BOOST_FIXTURE_TEST_SUITE(script_P2SH_tests, BasicTestingSetup) BOOST_FIXTURE_TEST_SUITE(script_p2sh_tests, BasicTestingSetup)
BOOST_AUTO_TEST_CASE(sign) BOOST_AUTO_TEST_CASE(sign)
{ {