-
Notifications
You must be signed in to change notification settings - Fork 38.6k
doc: Fix some typos #20762
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: Fix some typos #20762
Conversation
|
If you're going to fix typos, can you please fix all of them as seen in the spelling linter script src/core_read.cpp:131: presense ==> presence and update |
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsReviewers, this pull request conflicts with the following ones:
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. |
|
Additional typos suggested by @jonatack have now been edited in second commit.
edit: The pull request title should be |
|
ACK a95f3c364b71e122e773ba40ece7b614c79daa9f modulo addressing the nits suggested above |
|
LGTM, happy to ACK as soon as the commits are squashed. |
|
Update commit and PR title. @michaelfolkson I would like to ask another person for the second part. |
|
Running the spelling linter script, I saw that there is another instance of "crypted" that could be tackled in this PR:
|
|
False positives are now dealt with in the follow up PR (thanks @theStack). All current and future generations of Atacks are eternally grateful. Can you then just add the one remaining typo suggestion @eltociear, squash the commits and then this should be ready. The label of the PR needs to be changed from Build System to Docs by a maintainer. |
|
ACK 7ce93c752d19f570952e26649134bcbd2447b3a5 Welcome as a contributor @eltociear :) |
|
In this commit, can you please fix the remaining error signaled by the linter after #20817: and prefix the commit with |
|
@jonatack @michaelfolkson @practicalswift @theStack I'd added fix commit and squash commits. |
|
re-ACK 62a537652e2ae325980a683fb294ce017f21317f |
|
ACK 62a537652e2ae325980a683fb294ce017f21317f |
theStack
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 62a537652e2ae325980a683fb294ce017f21317f 🍾
hebasto
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Concept ACK.
IIUC, this PR initially was motivated by a change
accomodate -> accommodate
in the depends/packages/qt.mk file.
Currently, the depends/ directory is ignored by the lint-spelling.sh linter.
With the following patch:
--- a/test/lint/lint-spelling.sh
+++ b/test/lint/lint-spelling.sh
@@ -15,6 +15,6 @@ if ! command -v codespell > /dev/null; then
fi
IGNORE_WORDS_FILE=test/lint/lint-spelling.ignore-words.txt
-if ! codespell --check-filenames --disable-colors --quiet-level=7 --ignore-words=${IGNORE_WORDS_FILE} $(git ls-files -- ":(exclude)build-aux/m4/" ":(exclude)contrib/seeds/*.txt" ":(exclude)depends/" ":(exclude)doc/release-notes/" ":(exclude)src/leveldb/" ":(exclude)src/crc32c/" ":(exclude)src/qt/locale/" ":(exclude)src/qt/*.qrc" ":(exclude)src/secp256k1/" ":(exclude)src/univalue/"); then
+if ! codespell --check-filenames --disable-colors --quiet-level=7 --ignore-words=${IGNORE_WORDS_FILE} $(git ls-files -- ":(exclude)build-aux/m4/" ":(exclude)contrib/seeds/*.txt" ":(exclude)depends/config.guess" ":(exclude)depends/config.sub" ":(exclude)doc/release-notes/" ":(exclude)src/leveldb/" ":(exclude)src/crc32c/" ":(exclude)src/qt/locale/" ":(exclude)src/qt/*.qrc" ":(exclude)src/secp256k1/" ":(exclude)src/univalue/"); then
echo "^ Warning: codespell identified likely spelling errors. Any false positives? Add them to the list of ignored words in ${IGNORE_WORDS_FILE}"
fimore typos have been revealed:
depends/packages/qt.mk:220: accomodate ==> accommodate
depends/patches/fontconfig/gperf_header_regen.patch:5: inadvertant ==> inadvertent
depends/patches/native_cctools/ld64_disable_threading.patch:11: noticable ==> noticeable
depends/patches/qt/freetype_back_compat.patch:12: compatibile ==> compatible
depends/patches/qt/no-xlib.patch:56: glpyh ==> glyph
|
Happy New Year @eltociear! Let us know if you're happy to add these additional @hebasto typos or if you'd prefer someone to do these in a follow up PR. |
|
Another suggestion is to combine one more typo: s/Keypair/Key pair/ in bitcoin/src/bench/verify_script.cpp Line 27 in ae8f797
|
|
@michaelfolkson @hebasto Thank you! |
|
|
||
| +#if QT_CONFIG(xcb_xlib) && QT_CONFIG(library) | ||
| // Create a glpyh cursor if everything else failed | ||
| // Create a glyph cursor if everything else failed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can't modify the actual contents of a patch like this, because it will no longer apply. See all the CIs that are now failing:
patching file qtbase/src/plugins/platforms/xcb/qxcbcursor.cpp
Hunk #5 FAILED at 595.
1 out of 6 hunks FAILED -- saving rejects to file qtbase/src/plugins/platforms/xcb/qxcbcursor.cpp.rej
funcs.mk:267: recipe for target '/tmp/cirrus-ci-build/depends/work/build/x86_64-w64-mingw32/qt/5.9.8-ed5ca6e91a4/.stamp_preprocessed' failed
make: *** [/tmp/cirrus-ci-build/depends/work/build/x86_64-w64-mingw32/qt/5.9.8-ed5ca6e91a4/.stamp_preprocessed] Error 1
make: Leaving directory '/tmp/cirrus-ci-build/depends'…ump to codespell 2.0.0 f3ba916 lint: ignore gitian keys file for spelling linter (Sebastian Falbesoner) da289a6 lint: update list of spelling linter false positives (Sebastian Falbesoner) a0022f1 test: bump codespell linter version to 2.0.0 (Sebastian Falbesoner) Pull request description: This small patch updates the ignore list for the spelling linter script (which uses `codespell`), both removing false-positives that are not relevant anymore and adding new ones. As [suggested by jonatack](bitcoin/bitcoin#20762 (comment), whose last name is now also part of the list :)~~. Also changed the linter script to not check the gitian keys file, as [suggested by hebasto](bitcoin/bitcoin#20817 (comment)). The codespell version used is bumped to most recent version 2.0.0, which is more aware of some terms that were previously needed in the ignorelist for v1.17.1, see bitcoin/bitcoin#20817 (comment). Running spelling linter on master branch (repeated findings in the same file are removed to keep the output short): ``` $ ./test/lint/lint-spelling.sh contrib/gitian-keys/keys.txt:16: Atack ==> Attack doc/developer-notes.md:1284: inout ==> input, in out doc/psbt.md:122: Asend ==> Ascend, as end src/bench/verify_script.cpp:27: Keypair ==> Key pair src/blockencodings.h:30: Unser ==> Under, unset, unsure, user src/compressor.h:65: Unser ==> Under, unset, unsure, user src/core_read.cpp:131: presense ==> presence src/index/disktxpos.h:21: blockIn ==> blocking src/net_processing.h:67: anounce ==> announce src/netaddress.h:486: compatiblity ==> compatibility src/primitives/transaction.h:35: nIn ==> inn, min, bin, nine src/qt/bitcoinunits.cpp:101: nIn ==> inn, min, bin, nine src/rpc/blockchain.cpp:2150: nIn ==> inn, min, bin, nine src/rpc/misc.cpp:198: nIn ==> inn, min, bin, nine src/script/bitcoinconsensus.cpp:81: nIn ==> inn, min, bin, nine src/script/bitcoinconsensus.h:63: nIn ==> inn, min, bin, nine src/script/interpreter.cpp:1279: nIn ==> inn, min, bin, nine src/script/interpreter.h:222: nIn ==> inn, min, bin, nine src/script/sign.cpp:17: nIn ==> inn, min, bin, nine src/script/sign.h:39: nIn ==> inn, min, bin, nine src/serialize.h:181: Unser ==> Under, unset, unsure, user src/signet.cpp:142: nIn ==> inn, min, bin, nine src/test/base32_tests.cpp:17: fo ==> of, for src/test/base64_tests.cpp:17: fo ==> of, for src/test/script_tests.cpp:1509: nIn ==> inn, min, bin, nine src/test/sighash_tests.cpp:27: nIn ==> inn, min, bin, nine src/test/validation_tests.cpp:78: excercise ==> exercise src/undo.h:36: Unser ==> Under, unset, unsure, user src/validation.cpp:1403: nIn ==> inn, min, bin, nine src/validation.h:255: nIn ==> inn, min, bin, nine src/wallet/wallet.cpp:1532: nIn ==> inn, min, bin, nine src/wallet/walletdb.cpp:429: Crypted ==> Encrypted test/functional/feature_nulldummy.py:63: unnecssary ==> unnecessary test/functional/wallet_encryption.py:81: crypted ==> encrypted test/functional/wallet_upgradewallet.py:36: fpr ==> for, far, fps ^ Warning: codespell identified likely spelling errors. Any false positives? Add them to the list of ignored words in test/lint/lint-spelling.ignore-words.txt ``` Running spelling linter on PR branch: ``` $ ./test/lint/lint-spelling.sh src/core_read.cpp:131: presense ==> presence src/net_processing.h:67: anounce ==> announce src/netaddress.h:486: compatiblity ==> compatibility src/test/validation_tests.cpp:78: excercise ==> exercise src/wallet/walletdb.cpp:429: Crypted ==> Encrypted test/functional/feature_nulldummy.py:63: unnecssary ==> unnecessary test/functional/wallet_encryption.py:81: crypted ==> encrypted ^ Warning: codespell identified likely spelling errors. Any false positives? Add them to the list of ignored words in test/lint/lint-spelling.ignore-words.txt ``` This list of remaining findings doesn't contain false positives anymore -- the typos are fixed in PR bitcoin/bitcoin#20762. Happy new year! 🍾 ACKs for top commit: hebasto: re-ACK f3ba916, only suggested changes since my [previous](bitcoin/bitcoin#20817 (review)) review. jonatack: ACK f3ba916 I don't know if there are any particular issues with bumping codespell to v2.0.0, but locally running the spelling linter and the cirrus job at https://cirrus-ci.com/task/5004066998714368 both LGTM. Thanks for also verifying and removing the unused words from the ignore list. Tree-SHA512: e92ae6f16c01d4ff3d54f8c3a0ee95e12741f7bfe031d307a785f5cfd8a80525b16b34275f413b914c4a318f5166f9887399c21f2dad9cc7e9be41647042ef37
|
Thanks for your contribution. However to move things along I'm going to fix this up and consolidate it with some other changes. Your commit will still be attributed to you. |
1112035 doc: fix various typos (Ikko Ashimine) e864084 doc: Use https URLs where possible (Sawyer Billings) Pull request description: Consolidates / fixes the changes from #20762, #20836, #20810. There is no output when `test/lint/lint-all.sh` is run. Closes #20807. ACKs for top commit: MarcoFalke: ACK 1112035 Tree-SHA512: 22ca824688758281a74e5ebc6a84a358142351434e34c88c6b36045d2d241ab95fd0958565fd2060f98317e62e683323b5320cc7ec13592bf340e6922294ed78
accomodate -> accommodate