doc: Add missed copyright headers #17691

pull hebasto wants to merge 4 commits into bitcoin:master from hebasto:20191207-copyright-headers changing 22 files +89 −8

hebasto commented at 4:36 PM on December 7, 2019: member
This PR improves contrib/devtools/copyright_header.py script and adds copyright headers to the files in src and test directories with two exceptions:
- src/reverse_iterator.h (added to exceptions)
- src/test/fuzz/FuzzedDataProvider.h (added to exceptions)
On master 5622d8f3156a293e61d0964c33d4b21d8c9fd5e0:
```
$ ./contrib/devtools/copyright_header.py report . | grep zero
  25 with zero copyrights
```
With this PR:
```
$ ./contrib/devtools/copyright_header.py report . | grep zero
   2 with zero copyrights
```
~I am uncertain about our copyright policy with build_msvc and contrib directories content, so they are out of scope of this PR.~
practicalswift commented at 4:57 PM on December 7, 2019: contributor
Concept ACK

While we are at it: if we are to keep the external license links (to opensource.org) perhaps it is time to do the switch from http to https?

Alternatively we could just switch from …
```
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
```
… to …
```
// Distributed under the MIT software license, see the accompanying
// file COPYING.
```
I think I prefer the latter: using a link potentially introduces ambiguity and we shouldn't rely on external third party sites unless necessary :)
fanquake added the label Docs on Dec 7, 2019
fanquake commented at 6:23 PM on December 31, 2019: member

Concept ACK on adding the missing headers.

In the future I'd prefer if these scripts were moved out of bitcoin/bitcoin; maybe into the maintainer tools repository. To me it seems a bit ridiculous that we've got 600 lines of bash in this repository to do copyright header "management".
in contrib/devtools/copyright_header.py:494 in a5511dc766 outdated
```
 490 | @@ -491,17 +491,28 @@ def file_has_hashbang(file_lines):
 491 |          return False
 492 |      return file_lines[0][:2] == '#!'
 493 |  
 494 | +def insert_shell_header(filename, file_lines, start_year, end_year):
```
MarcoFalke commented at 2:26 PM on January 2, 2020:

Why is this needed? Couldn't the function where you copied this from be used?

hebasto commented at 3:35 PM on January 3, 2020:

Fixed.
MarcoFalke approved
MarcoFalke commented at 2:27 PM on January 2, 2020: member

To me it seems a bit ridiculous that we've got 600 lines of bash

I think it is python, but still ridiculous. Though having it in the repo, at least allows to do it in a scripted-diff. For the future, I am hoping we can get rid of the years after (c).
hebasto force-pushed on Jan 3, 2020
hebasto commented at 3:44 PM on January 3, 2020: member
@practicalswift I'm not sure that the license header content changing should be addressed by this PR. @MarcoFalke Your comment has been addressed. @sipsorcery What do you think about copyright headers in these files:
- build_msvc/bitcoin_config.h
- build_msvc/msvc-autogen.py
- build_msvc/testconsensus/testconsensus.cpp ? @dongcarl What do you think about copyright headers in these files:
- contrib/guix/guix-build.sh
- contrib/guix/libexec/build.sh ?
script: Add ability to insert copyright to *.sh 071f2fc204
script: Add empty line after C++ copyright 1998152f15
script: Update EXLUDE list in copyright_header.py 6fde9d5e47
hebasto force-pushed on Jan 3, 2020
sipsorcery commented at 10:38 AM on January 4, 2020: member

@hebasto sounds like a good idea to me. There was no particular reason copyright headers were left out of the files.

scripted-diff: Add missed copyright headers

-BEGIN VERIFY SCRIPT-
s() { contrib/devtools/copyright_header.py insert "$1"; }

s build_msvc/bitcoin_config.h
s build_msvc/msvc-autogen.py
s build_msvc/testconsensus/testconsensus.cpp
s contrib/devtools/circular-dependencies.py
s contrib/devtools/gen-manpages.sh
s contrib/filter-lcov.py
s contrib/gitian-build.py
s contrib/install_db4.sh
s src/crypto/sha256_avx2.cpp
s src/crypto/sha256_sse41.cpp
s src/fs.cpp
s src/qt/test/addressbooktests.cpp
s src/qt/test/addressbooktests.h
s src/qt/test/util.cpp
s src/qt/test/util.h
s src/qt/test/wallettests.cpp
s src/qt/test/wallettests.h
s src/test/blockchain_tests.cpp
s test/functional/combine_logs.py
s test/lint/lint-locale-dependence.sh
sed -i '1G' test/lint/lint-shebang.sh
s test/lint/lint-shebang.sh
-END VERIFY SCRIPT-

fac86ac7b3

hebasto force-pushed on Jan 4, 2020
hebasto commented at 6:23 PM on January 4, 2020: member

@sipsorcery

@hebasto sounds like a good idea to me. There was no particular reason copyright headers were left out of the files.

Thanks, missed headers are added in build_msvc/ subdirectory in the latest push.
MarcoFalke commented at 9:14 PM on January 6, 2020: member

ACK fac86ac7b3ceac2f884412c7a9f4bd5bab5e3916
MarcoFalke referenced this in commit 95ca6aeec7 on Jan 16, 2020
MarcoFalke merged this on Jan 16, 2020
MarcoFalke closed this on Jan 16, 2020
sidhujag referenced this in commit 178129465a on Jan 17, 2020
hebasto deleted the branch on Jan 18, 2020
MarkLTZ referenced this in commit 0a1571d657 on Apr 7, 2020
sidhujag referenced this in commit bafc0ded6a on Nov 10, 2020
Fabcien referenced this in commit d23d7fee22 on Jul 20, 2021
Fabcien referenced this in commit 8f12ff4b1e on Jul 20, 2021
deadalnix referenced this in commit 4cba34fcfc on Jul 21, 2021
DrahtBot locked this on Feb 15, 2022

Contributors

Labels