doc: add missing copyright headers #31864

pull fanquake wants to merge 4 commits into bitcoin:master from fanquake:copyright_cleanups changing 14 files +40 −17

fanquake commented at 3:44 pm on February 14, 2025: member

Add & amends a number of copyright headers. Remove some now obselete doc/code.
DrahtBot commented at 3:44 pm on February 14, 2025: contributor
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage & Benchmarks

For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/31864.

Reviews

See the guideline for information on the review process.

Type Reviewers

ACK willcl-ark

Stale ACK i-am-yuvi, l0rinc

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

Conflicts

Reviewers, this pull request conflicts with the following ones:
- #32562 (doc: remove // for … comments by fanquake)
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.
DrahtBot added the label Docs on Feb 14, 2025
i-am-yuvi commented at 8:46 am on February 16, 2025: contributor

ACK 01b9a6183eb58dffac00f053e2742d924c84c721
in contrib/devtools/copyright_header.py:25 in 01b9a6183e outdated
21@@ -22,7 +22,6 @@ 22 'src/test/fuzz/FuzzedDataProvider.h', 23 'src/tinyformat.h', 24 'src/bench/nanobench.h', 25- 'test/functional/test_framework/bignum.py',
l0rinc commented at 12:10 pm on February 18, 2025:

👍 was removed in https://github.com/bitcoin/bitcoin/commit/3ed772d2219e58d6afea3d12c0ebebb8487445e7
in src/bench/parse_hex.cpp:1 in 01b9a6183e outdated
0@@ -1,4 +1,4 @@ 1-// Copyright (c) 2024- The Bitcoin Core developers 2+// Copyright (c) 2024-present The Bitcoin Core developers
l0rinc commented at 12:34 pm on February 18, 2025:

How were these files chosen for update? I see that many other headers are missing the -present part:

https://github.com/bitcoin/bitcoin/blob/01b9a6183eb58dffac00f053e2742d924c84c721/src/node/abort.cpp#L1

https://github.com/bitcoin/bitcoin/blob/01b9a6183eb58dffac00f053e2742d924c84c721/src/common/args.h#L1

https://github.com/bitcoin/bitcoin/blob/01b9a6183eb58dffac00f053e2742d924c84c721/src/bech32.h#L2

and many others have a older end year:

https://github.com/bitcoin/bitcoin/blob/01b9a6183eb58dffac00f053e2742d924c84c721/src/bech32.cpp#L2

https://github.com/bitcoin/bitcoin/blob/01b9a6183eb58dffac00f053e2742d924c84c721/src/init/bitcoind.cpp#L1

https://github.com/bitcoin/bitcoin/blob/01b9a6183eb58dffac00f053e2742d924c84c721/ci/test/00_setup_env.sh#L3

or don’t even contain a year:

https://github.com/bitcoin/bitcoin/blob/01b9a6183eb58dffac00f053e2742d924c84c721/ci/lint_imagefile#L1

or have the SPDX header only:

https://github.com/bitcoin/bitcoin/blob/01b9a6183eb58dffac00f053e2742d924c84c721/src/test/fuzz/FuzzedDataProvider.h#L5

or don’t have any copyright header:

https://github.com/bitcoin/bitcoin/blob/01b9a6183eb58dffac00f053e2742d924c84c721/test/lint/lint_ignore_dirs.py#L1

https://github.com/bitcoin/bitcoin/blob/01b9a6183eb58dffac00f053e2742d924c84c721/src/univalue/include/univalue_escapes.h#L1

etc.
in contrib/devtools/copyright_header.py:97 in 01b9a6183e outdated
92@@ -94,7 +93,6 @@ def compile_copyright_regex(copyright_style, year_style, name): 93 r"Satoshi Nakamoto", 94 r"The Bitcoin Core developers", 95 r"BitPay Inc\.", 96- r"University of Illinois at Urbana-Champaign\.",
l0rinc commented at 12:48 pm on February 18, 2025:

Only found these in Python dependencies, so: 👍

Unrelated: we could update the script to change the end year to present instead

fanquake commented at 6:44 pm on February 20, 2025:

I have changes for this locally, but the value is low, and ideally all of this code will soon be removed.
l0rinc approved
l0rinc commented at 12:48 pm on February 18, 2025: contributor

While I admit having stronger feelings against the copyright headers than I should (noise + bikeshedding + revoking right to copy in general), I do value consistency, so it’s a 👍 from me - I wish we could unify more to get rid of this extra source of disagreement, but this PR makes it a bit better, so:

ACK 01b9a6183eb58dffac00f053e2742d924c84c721
fanquake force-pushed on Mar 7, 2025

Type	Reviewers
ACK	willcl-ark
Stale ACK	i-am-yuvi, l0rinc

in src/node/peerman_args.cpp:3 in d58874a30a outdated

0@@ -1,3 +1,7 @@
1+// Copyright (c) 2023-present The Bitcoin Core developers
2+// Distributed under the MIT software license, see the accompanying
3+// file COPYING or http://www.opensource.org/licenses/mit-license.php.

l0rinc commented at 8:42 pm on March 8, 2025:

Is there any reason for not updating these as well?

0// file COPYING or https://opensource.org/license/MIT.

in src/wallet/migrate.cpp:1 in d58874a30a outdated
0@@ -1,3 +1,4 @@ 1+// Copyright (c) 2024 The Bitcoin Core developers
l0rinc commented at 8:45 pm on March 8, 2025:

I see you’ve removed the 2024-present from the latest push - is that a general direction from now on?

l0rinc commented at 8:49 pm on March 8, 2025: contributor

Not entirely clear to me which MIT license URL we’re using now, and when we’re using year ranges and when single years.

The changes since my last ack:

  0diff --git a/src/clientversion.cpp b/src/clientversion.cpp
  1--- a/src/clientversion.cpp(revision f4fec329f5353d2b904659e129ade239fee09d89)
  2+++ b/src/clientversion.cpp(date 1741466438223)
  3@@ -96,6 +96,6 @@
  4            "\n" +
  5            "\n" +
  6            _("This is experimental software.") + "\n" +
  7-           strprintf(_("Distributed under the MIT software license, see the accompanying file %s or %s"), "COPYING", "<https://opensource.org/licenses/MIT>").translated +
  8+           strprintf(_("Distributed under the MIT software license, see the accompanying file %s or %s"), "COPYING", "<https://opensource.org/license/MIT>").translated +
  9            "\n";
 10 }
 11Index: src/node/txdownloadman_impl.h
 12<+>UTF-8
 13===================================================================
 14diff --git a/src/node/txdownloadman_impl.h b/src/node/txdownloadman_impl.h
 15--- a/src/node/txdownloadman_impl.h(revision f4fec329f5353d2b904659e129ade239fee09d89)
 16+++ b/src/node/txdownloadman_impl.h(date 1741466438223)
 17@@ -1,4 +1,4 @@
 18-// Copyright (c) 2024-present The Bitcoin Core developers
 19+// Copyright (c) 2024 The Bitcoin Core developers
 20 // Distributed under the MIT software license, see the accompanying
 21 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 22 #ifndef BITCOIN_NODE_TXDOWNLOADMAN_IMPL_H
 23Index: src/univalue/test/test_json.cpp
 24<+>UTF-8
 25===================================================================
 26diff --git a/src/univalue/test/test_json.cpp b/src/univalue/test/test_json.cpp
 27--- a/src/univalue/test/test_json.cpp(revision f4fec329f5353d2b904659e129ade239fee09d89)
 28+++ b/src/univalue/test/test_json.cpp(date 1741466438224)
 29@@ -1,3 +1,8 @@
 30+// Copyright 2014 BitPay Inc.
 31+// Copyright 2015-present Bitcoin Core Developers
 32+// Distributed under the MIT software license, see the accompanying
 33+// file COPYING or https://opensource.org/licenses/mit-license.php.
 34+
 35 // Test program that can be called by the JSON test suite at
 36 // https://github.com/nst/JSONTestSuite.
 37 //
 38Index: src/node/txdownloadman_impl.cpp
 39<+>UTF-8
 40===================================================================
 41diff --git a/src/node/txdownloadman_impl.cpp b/src/node/txdownloadman_impl.cpp
 42--- a/src/node/txdownloadman_impl.cpp(revision f4fec329f5353d2b904659e129ade239fee09d89)
 43+++ b/src/node/txdownloadman_impl.cpp(date 1741466438223)
 44@@ -1,4 +1,4 @@
 45-// Copyright (c) 2024-present The Bitcoin Core developers
 46+// Copyright (c) 2024 The Bitcoin Core developers
 47 // Distributed under the MIT software license, see the accompanying
 48 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 49 
 50Index: src/univalue/include/univalue_escapes.h
 51<+>UTF-8
 52===================================================================
 53diff --git a/src/univalue/include/univalue_escapes.h b/src/univalue/include/univalue_escapes.h
 54--- a/src/univalue/include/univalue_escapes.h(revision f4fec329f5353d2b904659e129ade239fee09d89)
 55+++ b/src/univalue/include/univalue_escapes.h(date 1741466438224)
 56@@ -1,3 +1,8 @@
 57+// Copyright 2014 BitPay Inc.
 58+// Copyright 2015-present Bitcoin Core Developers
 59+// Distributed under the MIT software license, see the accompanying
 60+// file COPYING or https://opensource.org/licenses/mit-license.php.
 61+
 62 #ifndef BITCOIN_UNIVALUE_INCLUDE_UNIVALUE_ESCAPES_H
 63 #define BITCOIN_UNIVALUE_INCLUDE_UNIVALUE_ESCAPES_H
 64 static const char *escapes[256] = {
 65Index: src/bench/parse_hex.cpp
 66<+>UTF-8
 67===================================================================
 68diff --git a/src/bench/parse_hex.cpp b/src/bench/parse_hex.cpp
 69--- a/src/bench/parse_hex.cpp(revision f4fec329f5353d2b904659e129ade239fee09d89)
 70+++ b/src/bench/parse_hex.cpp(date 1741466438223)
 71@@ -1,4 +1,4 @@
 72-// Copyright (c) 2024-present The Bitcoin Core developers
 73+// Copyright (c) 2024- The Bitcoin Core developers
 74 // Distributed under the MIT software license, see the accompanying
 75 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 76 
 77Index: src/util/transaction_identifier.h
 78<+>UTF-8
 79===================================================================
 80diff --git a/src/util/transaction_identifier.h b/src/util/transaction_identifier.h
 81--- a/src/util/transaction_identifier.h(revision f4fec329f5353d2b904659e129ade239fee09d89)
 82+++ b/src/util/transaction_identifier.h(date 1741466438224)
 83@@ -1,4 +1,4 @@
 84-// Copyright (c) 2023-present The Bitcoin Core developers
 85+// Copyright (c) 2023 The Bitcoin Core developers
 86 // Distributed under the MIT software license, see the accompanying
 87 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 88 
 89Index: README.md
 90<+>UTF-8
 91===================================================================
 92diff --git a/README.md b/README.md
 93--- a/README.md(revision f4fec329f5353d2b904659e129ade239fee09d89)
 94+++ b/README.md(date 1741466438223)
 95@@ -19,7 +19,7 @@
 96 -------
 97 
 98 Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
 99-information or see https://opensource.org/licenses/MIT.
100+information or see https://opensource.org/license/MIT.
101 
102 Development Process
103 -------------------
104Index: test/lint/lint_ignore_dirs.py
105<+>UTF-8
106===================================================================
107diff --git a/test/lint/lint_ignore_dirs.py b/test/lint/lint_ignore_dirs.py
108--- a/test/lint/lint_ignore_dirs.py(revision f4fec329f5353d2b904659e129ade239fee09d89)
109+++ b/test/lint/lint_ignore_dirs.py(date 1741466438224)
110@@ -1,3 +1,9 @@
111+#!/usr/bin/env python3
112+#
113+# Copyright (c) 2024 The Bitcoin Core developers
114+# Distributed under the MIT software license, see the accompanying
115+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
116+
117 SHARED_EXCLUDED_SUBTREES = ["src/leveldb/",
118                  "src/crc32c/",
119                  "src/secp256k1/",
120Index: src/wallet/migrate.cpp
121<+>UTF-8
122===================================================================
123diff --git a/src/wallet/migrate.cpp b/src/wallet/migrate.cpp
124--- a/src/wallet/migrate.cpp(revision f4fec329f5353d2b904659e129ade239fee09d89)
125+++ b/src/wallet/migrate.cpp(date 1741466438224)
126@@ -1,4 +1,4 @@
127-// Copyright (c) 2024-present The Bitcoin Core developers
128+// Copyright (c) 2024 The Bitcoin Core developers
129 // Distributed under the MIT software license, see the accompanying
130 // file COPYING or http://www.opensource.org/licenses/mit-license.php.

fanquake force-pushed on Apr 4, 2025
fanquake force-pushed on Apr 17, 2025
fanquake force-pushed on May 2, 2025
contrib: remove GPL-3+ from debian/copyright
This is unused.
6854497b47
doc: update MIT license URL 0817f2d6cf
contrib: remove outdated entries from copyright_header.py f667000c83
doc: add & amend copyright headers c7c3bfadfc
fanquake force-pushed on May 20, 2025
willcl-ark approved
willcl-ark commented at 10:53 am on May 20, 2025: member
ACK c7c3bfadfc6e294547cbc0077a175845c0633906

This changeset:
- Adds copyright headers to files where they’re missing
- Updates copyright headers which are missing “group” info (i.e. to whom the copyright is granted)
It does not update all headers with “-present”. This is left for a future change.

I did a cursory check on git files to see if any had been missed using:
0❯ fd -e cpp -e h -e py -E src/secp256k1 -E src/leveldb -E src/minisketch -E src/crc32 | xargs rg --pcre2 -l -e "Copyright(?!.*present)" | xargs rg Copyright -A2
The results look good to me: https://paste.256k1.dev/lasmaolowe.log
DrahtBot requested review from i-am-yuvi on May 20, 2025
DrahtBot requested review from l0rinc on May 20, 2025
fanquake merged this on May 20, 2025
fanquake closed this on May 20, 2025
fanquake deleted the branch on May 20, 2025

Contributors
fanquake DrahtBot i-am-yuvi l0rinc willcl-ark

Review Requested
l0rinc i-am-yuvi

Labels
Docs

doc: add missing copyright headers #31864

Code Coverage & Benchmarks

Reviews

Conflicts