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

pull practicalswift wants to merge 2 commits into bitcoin:master from practicalswift:lowercase-filenames changing 7 files +12 −6

practicalswift commented at 1:54 PM on May 23, 2018: contributor

Add a note about the source code filename naming convention.
docs: Add a note about the source code filename naming convention 419a1983ca

fanquake commented at 1:59 PM on May 23, 2018: member

The test suite in file src/test/foo_tests.cpp should be named
"foo_tests". Please make sure the following test suites follow
that convention:
src/test/denialofservice_tests.cpp:BOOST_FIXTURE_TEST_SUITE(DoS_tests, TestingSetup)
^---- failure generated from contrib/devtools/lint-tests.sh

Do not use uppercase characters in source code filenames e56771365b
practicalswift force-pushed on May 23, 2018
practicalswift commented at 2:08 PM on May 23, 2018: contributor

@fanquake Fixed! Thanks! :-)
fanquake added the label Docs on May 23, 2018
ken2812221 commented at 12:09 PM on May 24, 2018: contributor

Concept ACK

practicalswift commented at 12:32 PM on May 24, 2018: contributor

Some data –

Current violations:

$ git ls-files -- "*.cpp" "*.h" | grep -vE '^[a-z0-9/_-]*\.(cpp|h)$' | grep -vE '^src/secp256k1/' | sort -u
src/bench/Examples.cpp
src/test/DoS_tests.cpp
src/test/script_P2SH_tests.cpp

Historical violations:

$ git log -u | grep -E '^\+\+\+ .*\.(cpp|h)$' | cut -b7- | grep -vE '^[a-z0-9/_-]*\.(cpp|h)$' | grep -vE '^src/secp256k1/' | sort -u
AboutDialog.cpp
AboutDialog.h
AddressBookDialog.cpp
AddressBookDialog.h
AddressTableModel.cpp
AddressTableModel.h
BitcoinGUI.cpp
BitcoinGUI.h
moc_BitcoinGUI.cpp
OptionsDialog.cpp
OptionsDialog.h
SendCoinsDialog.cpp
SendCoinsDialog.h
SettingsDialog.cpp
SettingsDialog.h
src/bench/Examples.cpp
src/bench/MilliSleep.cpp
src/java/org_bitcoin_NativeSecp256k1.h
src/java/org_bitcoin_Secp256k1Context.h
src/test/Checkpoints_tests.cpp
src/test/DoS_tests.cpp
src/test/script_P2SH_tests.cpp
TransactionTableModel.cpp
TransactionTableModel.h

fanquake commented at 11:30 AM on May 28, 2018: member

Concept ACK
in src/Makefile.test.include:49 in e56771365b
```
  45 | @@ -46,7 +46,7 @@ BITCOIN_TESTS =\
  46 |    test/compress_tests.cpp \
  47 |    test/crypto_tests.cpp \
  48 |    test/cuckoocache_tests.cpp \
  49 | -  test/DoS_tests.cpp \
  50 | +  test/denialofservice_tests.cpp \
```
ken2812221 commented at 7:04 PM on May 28, 2018:

Why expand this?

practicalswift commented at 10:48 PM on May 28, 2018:

dos could mean DOS or DoS :-)

randolf commented at 10:51 PM on May 30, 2018:

While "DoS" is clearly "Denial of Service" (and not "Disk Operating System {DOS}"), I find that it's generally better to avoid using acronyms in order to simplify future code reviews, inspections, etc.
randolf approved
MarcoFalke commented at 5:36 PM on June 8, 2018: member

utACK e56771365b446fa7f51a17d67f3fbe560baaa5a5
Empact commented at 12:45 AM on June 12, 2018: member

utACK e567713
promag commented at 7:08 AM on June 12, 2018: member

utACK e567713.
ken2812221 commented at 9:49 AM on June 12, 2018: contributor

utACK e567713
MarcoFalke merged this on Jun 12, 2018
MarcoFalke closed this on Jun 12, 2018
MarcoFalke referenced this in commit b22115d9a3 on Jun 12, 2018
PastaPastaPasta referenced this in commit f77b58e89f on Jul 7, 2020
practicalswift deleted the branch on Apr 10, 2021
gades referenced this in commit 6ce15a79c0 on Mar 17, 2022
DrahtBot locked this on Aug 18, 2022

Contributors

Labels