[doc] Fix doxygen off-by-one comments, fix typos #8607

pull MarcoFalke wants to merge 4 commits into bitcoin:master from MarcoFalke:Mf1608-trivial17 changing 8 files +44 −44

MarcoFalke commented at 7:09 PM on August 26, 2016: member
Also
- Make import zmq error fatal again (instead of silent ignore)
- Make fix-copyright-headers.py more portable
init: Fix typo in help message for -whitelistforcerelay
Reported by pryds on Transifex in the Danish translation.
67a55025a1
[qa] pull-tester: Don't mute zmq ImportError fabfd5dae2
[doc] Fix typos in comments, doxygen: Fix comment syntax fa27c0a2c4
contrib: Make fix-copyright-headers.py more portable fafe7b3432
MarcoFalke added the label Docs and Output on Aug 26, 2016
MarcoFalke commented at 7:28 PM on August 26, 2016: member

Example of comments being of by one: https://dev.visucore.com/bitcoin/doxygen/chain_8h.html#a0d8c285f70a59a32f4f6ab41b78f93ada722a05d892a13ada5ffd4fcbbef837cd
luke-jr commented at 2:20 AM on August 27, 2016: member

ACK

in src/script/sign.h:None in fafe7b3432

  50 | @@ -51,7 +51,7 @@ class MutableTransactionSignatureCreator : public TransactionSignatureCreator {
  51 |      MutableTransactionSignatureCreator(const CKeyStore* keystoreIn, const CMutableTransaction* txToIn, unsigned int nInIn, const CAmount& amount, int nHashTypeIn) : TransactionSignatureCreator(keystoreIn, &tx, nInIn, amount, nHashTypeIn), tx(*txToIn) {}
  52 |  };
  53 |  
  54 | -/** A signature creator that just produces 72-byte empty signatyres. */

laanwj commented at 6:11 AM on August 27, 2016:

SignaTyres™

in contrib/devtools/fix-copyright-headers.py:None in fafe7b3432
```
  15 | @@ -16,7 +16,7 @@
  16 |  import re
  17 |  
  18 |  year = time.gmtime()[0]
  19 | -CMD_GIT_DATE = 'git log --format=@%%at -1 %s | date +"%%Y" -u -f -'
  20 | +CMD_GIT_DATE = 'git log --format=%%ad --date=short -1 %s | cut -d"-" -f 1'
```
laanwj commented at 6:12 AM on August 27, 2016:

Whyy oh whyy are we using shell commands in a python script? (no need to fix in this pull, but all those string operations could just be done in Python, more portable and potentially more secure, no shell calls means no shell escapes)

Oh I should have read on. A few lines down we're even calling perl from Python.

MarcoFalke commented at 9:24 AM on August 27, 2016:

Lazy<sup>TM</sup> and ItWorks<sup>TM</sup>, also you need to call at least git to make this script work. Though, I agree that calling perl is not required. (I won't change it in this pull, though.)

btcdrak commented at 9:46 AM on August 28, 2016:

Make it go full circle. Perl should call Python.

laanwj commented at 12:04 PM on August 28, 2016:

LazyTM and ItWorksTM, also you need to call at least git to make this script work.

You don't need to call it through the shell though. Popen, by default, just invokes the process directly. See e.g. how github-merge.py interacts with git.
laanwj commented at 6:19 AM on August 27, 2016: member

utACK
btcdrak commented at 9:47 AM on August 28, 2016: contributor

utACK
laanwj merged this on Aug 28, 2016
laanwj closed this on Aug 28, 2016
laanwj referenced this in commit a5bb6387f7 on Aug 28, 2016
MarcoFalke deleted the branch on Aug 28, 2016
luke-jr referenced this in commit 9556745dc2 on Sep 21, 2016
luke-jr referenced this in commit c18a9ca788 on Sep 21, 2016
luke-jr referenced this in commit 486650ae6a on Sep 21, 2016
luke-jr referenced this in commit 752fbae697 on Sep 21, 2016
codablock referenced this in commit b65ea52e64 on Sep 19, 2017
codablock referenced this in commit 6967e0df15 on Jan 9, 2018
codablock referenced this in commit 22604cbbcc on Jan 9, 2018
lateminer referenced this in commit 62de6f69d5 on Oct 24, 2018
lateminer referenced this in commit 66e2824d28 on Nov 9, 2018
andvgal referenced this in commit 1866026fea on Jan 6, 2019
zkbot referenced this in commit 025bd44543 on Nov 21, 2020
zkbot referenced this in commit 7a0a268054 on Dec 2, 2020
zkbot referenced this in commit c8896f9907 on Dec 2, 2020
DrahtBot locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#8621 [contrib] python: Don't use shell=True