doc: Fix typos pointed out by lint-spelling by brunoerg · Pull Request #24203 · bitcoin/bitcoin

brunoerg · 2022-01-29T22:20:51Z

Occuring -> occurring (random.h)
Covert -> convert (chacha_poly_aead.cpp)
Fix nWe false positive in blockchain.cpp (#24203 (comment))

Got it by linter, other ones are false positives.

src/random.h

DrahtBot · 2022-01-30T05:00:25Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#23813 (Add test and docs for getblockfrompeer with pruning by fjahr)
#23441 (fuzz: Differential fuzzing for ChaCha20Forward4064-Poly1305@bitcoin cipher suite by stratospher)
#23233 (BIP324: Add encrypted p2p transport {de}serializer by dhruv)
#20962 (Alter the ChaCha20Poly1305@Bitcoin AEAD to the new specification by jonasschnelli)

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.

prusnak

utACK 9255261aba5663065abda29867078f0faa288cd7

shaavan

Concept ACK

I agree with @jonatack suggestion. This PR's scope should be broadened to correct all the lint spelling check instances, either by fixing the typo or marking the instances as false positive.

After the recent update of the PR. There are still three instances in the lint-spelling.sh test that needs to be addressed:

nWe
creat
ba

I would also suggest renaming the PR heading to better to infer the new general goal of this PR.

prusnak · 2022-01-30T10:51:39Z

nWe

creat

ba

These are all three false positives. Suggestion for fixing the nWe one:

--- a/src/rpc/blockchain.cpp
+++ b/src/rpc/blockchain.cpp
@@ -790,10 +790,10 @@ static RPCHelpMan getblockfrompeer()
 {
     return RPCHelpMan{
         "getblockfrompeer",
-        "Attempt to fetch block from a given peer.\n"
-        "\nWe must have the header for this block, e.g. using submitheader.\n"
-        "Subsequent calls for the same block and a new peer will cause the response from the previous peer to be ignored.\n"
-        "\nReturns an empty JSON object if the request was successfully scheduled.",
+        "Attempt to fetch block from a given peer.\n\n"
+        "We must have the header for this block, e.g. using submitheader.\n"
+        "Subsequent calls for the same block and a new peer will cause the response from the previous peer to be ignored.\n\n"
+        "Returns an empty JSON object if the request was successfully scheduled.",
         {
             {"block_hash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The block hash to try to fetch"},
             {"peer_id", RPCArg::Type::NUM, RPCArg::Optional::NO, "The peer to fetch it from (see getpeerinfo for peer IDs)"},

brunoerg · 2022-01-30T11:40:50Z

Nice suggestion @prusnak for nWe. Going to address it.

src/rpc/blockchain.cpp

brunoerg · 2022-01-30T12:00:05Z

force-pushed addressing @prusnak's comments

w0xlt

ACK bad0e7f

jonatack · 2022-01-30T15:42:39Z

test/lint/lint-spelling.sh still returns:

src/util/syscall_sandbox.cpp:128: creat ==> create
test/functional/data/rpc_decodescript.json:81: ba ==> by, be
test/functional/data/rpc_decodescript.json:84: ba ==> by, be

Suggestion

--- a/test/lint/lint-spelling.ignore-words.txt
+++ b/test/lint/lint-spelling.ignore-words.txt
@@ -1,6 +1,9 @@
 asend
+ba
 blockin
 cachable
+creat
 fo
 fpr
 hights

(creat is a valid linux syscall)

katesalazar · 2022-01-30T15:54:53Z

Concept ACK

brunoerg · 2022-01-30T19:17:21Z

force-pushed addressing @jonatack's comments. Thank you for the reviews!

prusnak

ACK 58ccc88

tested that ./test/lint/lint-spelling.sh returns no errors

PastaPastaPasta

utACK, it's good to fix this. The changes make sense, I did not validate that the linter output is clean now.

58ccc88 lint: add creat and ba into ignore-words for lint-spelling (brunoerg) bad0e7f doc: Fix typos pointed out by lint-spelling (brunoerg) Pull request description: Occuring -> occurring (random.h) Covert -> convert (chacha_poly_aead.cpp) Fix `nWe` false positive in blockchain.cpp (bitcoin#24203 (comment)) Got it by linter, other ones are false positives. ACKs for top commit: prusnak: ACK 58ccc88 Tree-SHA512: b350d0e64968b96ead226da0be6aa4ca3f8e482ae401697867684ce8478e96b954124b3dea6dcd697aad4206f209f32f238d7cf0a0589075f24f5cf629c563f3

jonatack reviewed Jan 29, 2022

View reviewed changes

src/random.h Outdated Show resolved Hide resolved

DrahtBot added the Docs label Jan 29, 2022

brunoerg changed the title ~~doc: Fix typo in random.h~~ doc: Fix typo in random.h and chacha_poly_aead.cpp Jan 29, 2022

brunoerg force-pushed the 2022-fix-typo-randomh branch from 094fc29 to 9255261 Compare January 29, 2022 23:08

DrahtBot mentioned this pull request Jan 30, 2022

fuzz: Differential fuzzing for ChaCha20Forward4064-Poly1305@bitcoin cipher suite #23441

Closed

prusnak approved these changes Jan 30, 2022

View reviewed changes

DrahtBot mentioned this pull request Jan 30, 2022

BIP324: Add encrypted p2p transport {de}serializer #23233

Closed

shaavan reviewed Jan 30, 2022

View reviewed changes

brunoerg changed the title ~~doc: Fix typo in random.h and chacha_poly_aead.cpp~~ doc: Fix typos pointed by lint-spelling Jan 30, 2022

brunoerg changed the title ~~doc: Fix typos pointed by lint-spelling~~ doc: Fix typos pointed out by lint-spelling Jan 30, 2022

brunoerg force-pushed the 2022-fix-typo-randomh branch from 9255261 to 80045cf Compare January 30, 2022 11:45

prusnak suggested changes Jan 30, 2022

View reviewed changes

src/rpc/blockchain.cpp Outdated Show resolved Hide resolved

doc: Fix typos pointed out by lint-spelling

bad0e7f

brunoerg force-pushed the 2022-fix-typo-randomh branch from 80045cf to bad0e7f Compare January 30, 2022 11:59

DrahtBot mentioned this pull request Jan 30, 2022

Alter the ChaCha20Poly1305@Bitcoin AEAD to the new specification #20962

Closed

w0xlt approved these changes Jan 30, 2022

View reviewed changes

lint: add creat and ba into ignore-words for lint-spelling

58ccc88

DrahtBot mentioned this pull request Jan 30, 2022

Add test and docs for getblockfrompeer with pruning #23813

Merged

prusnak approved these changes Jan 30, 2022

View reviewed changes

PastaPastaPasta approved these changes Jan 31, 2022

View reviewed changes

maflcko merged commit af7b077 into bitcoin:master Jan 31, 2022

bitcoin locked and limited conversation to collaborators Jan 31, 2023

Conversation

brunoerg commented Jan 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

DrahtBot commented Jan 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Conflicts

Uh oh!

prusnak left a comment

Choose a reason for hiding this comment

Uh oh!

shaavan left a comment

Choose a reason for hiding this comment

Uh oh!

prusnak commented Jan 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brunoerg commented Jan 30, 2022

Uh oh!

Uh oh!

brunoerg commented Jan 30, 2022

Uh oh!

w0xlt left a comment

Choose a reason for hiding this comment

Uh oh!

jonatack commented Jan 30, 2022

Uh oh!

katesalazar commented Jan 30, 2022

Uh oh!

brunoerg commented Jan 30, 2022

Uh oh!

prusnak left a comment

Choose a reason for hiding this comment

Uh oh!

PastaPastaPasta left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

brunoerg commented Jan 29, 2022 •

edited

Loading

DrahtBot commented Jan 30, 2022 •

edited

Loading

prusnak commented Jan 30, 2022 •

edited

Loading