Fix spelling mistakes and CI spellcheck job

This commit is contained in:
Marenz 2022-08-18 13:43:16 +02:00
parent 86ab18c9af
commit 1b5332c2b9
12 changed files with 36 additions and 29 deletions

View File

@ -652,7 +652,7 @@ jobs:
pip install --user codespell pip install --user codespell
- run: - run:
name: Check spelling name: Check spelling
command: ~/.local/bin/codespell -S "*.enc,.git,Dockerfile*" -I ./scripts/codespell_whitelist.txt command: ~/.local/bin/codespell -S "*.enc,.git,Dockerfile*,LICENSE,codespell_whitelist.txt,codespell_ignored_lines.txt" -I ./scripts/codespell_whitelist.txt -x ./scripts/codespell_ignored_lines.txt
- gitter_notify_failure_unless_pr - gitter_notify_failure_unless_pr
chk_docs_examples: chk_docs_examples:

View File

@ -132,7 +132,7 @@ public:
/// @returns true if the knowledge about the state of both objects is (known to be) equal. /// @returns true if the knowledge about the state of both objects is (known to be) equal.
bool operator==(KnownState const& _other) const; bool operator==(KnownState const& _other) const;
/// Retrieves the current equivalence class fo the given stack element (or generates a new /// Retrieves the current equivalence class for the given stack element (or generates a new
/// one if it does not exist yet). /// one if it does not exist yet).
Id stackElement(int _stackHeight, langutil::SourceLocation const& _location); Id stackElement(int _stackHeight, langutil::SourceLocation const& _location);
/// @returns the stackElement relative to the current stack height. /// @returns the stackElement relative to the current stack height.

View File

@ -425,7 +425,7 @@ Token Scanner::scanMultiLineDocComment()
while (!isSourcePastEndOfInput()) while (!isSourcePastEndOfInput())
{ {
//handle newlines in multline comments // handle newlines in multiline comments
if (atEndOfLine()) if (atEndOfLine())
{ {
skipWhitespace(); skipWhitespace();

View File

@ -206,7 +206,7 @@ inline std::string formatNumberReadable(
} }
} }
/// Safely converts an usigned integer as string into an unsigned int type. /// Safely converts an unsigned integer as string into an unsigned int type.
/// ///
/// @return the converted number or nullopt in case of an failure (including if it would not fit). /// @return the converted number or nullopt in case of an failure (including if it would not fit).
inline std::optional<unsigned> toUnsignedInt(std::string const& _value) inline std::optional<unsigned> toUnsignedInt(std::string const& _value)

View File

@ -0,0 +1,20 @@
A constant BT = BU;
A constant BU = BV;
A constant FN = FO;
A constant FO = FP;
struct BT { BU m; }
struct BU { BV m; }
struct FN { FO m; }
struct FO { FP m; }
// encode_inline_asm(bytes): 0x20, 2, "fo" -> 0x20, 4, "Zm8="
// encode_no_asm(bytes): 0x20, 2, "fo" -> 0x20, 4, "Zm8="
BOOST_TEST(mutation(chromosome) == Chromosome("fo"));
docker run --rm -v "${OUTPUTDIR}":/tmp/output -v "${SCRIPTDIR}":/tmp/scripts:ro -it trzeci/emscripten:sdk-tag-1.39.3-64bit /tmp/scripts/docker-scripts/rebuild_tags.sh "${TAGS}" /tmp/output "$@"
<assignEnd>
<assignEnd>
<assignEnd>
templ("assignEnd", dynamic ? "end := pos" : "");
templ("assignEnd", dynamic ? "end := pos" : "");
templ("assignEnd", "end := pos");
templ("assignEnd", "end := tail");
templ("assignEnd", "");

View File

@ -1,16 +1,3 @@
iff
nd nd
assignend
uint
mut
BA
FO
ba
fo
compilability compilability
errorstring
hist
otion
keypair keypair
ether
sur

View File

@ -79,7 +79,7 @@ The above is the workflow to use when the update is straightforward and looks sa
fine to just modify the branches directly. If this is not the case, it is recommended to first perform the fine to just modify the branches directly. If this is not the case, it is recommended to first perform the
operation on copies of these version-specific branches and test them by creating PRs on `develop` and operation on copies of these version-specific branches and test them by creating PRs on `develop` and
`breaking` to see if tests pass. The PRs should just modify project scripts in `test/externalScripts/` `breaking` to see if tests pass. The PRs should just modify project scripts in `test/externalScripts/`
to use the updated copies of the branches and can be discarded aferwards without being merged. to use the updated copies of the branches and can be discarded afterwards without being merged.
#### Changes needed after a breaking release of the compiler #### Changes needed after a breaking release of the compiler
When a non-backwards-compatible version becomes the most recent release, `breaking` branch When a non-backwards-compatible version becomes the most recent release, `breaking` branch

View File

@ -714,10 +714,10 @@ BOOST_AUTO_TEST_CASE(cse_keccak256_twice_same_content_noninterfering_store_in_be
Instruction::MSTORE, // m[12] = DUP1 Instruction::MSTORE, // m[12] = DUP1
Instruction::DUP12, Instruction::DUP12,
u256(12 + 32), u256(12 + 32),
Instruction::MSTORE, // does not destoy memory knowledge Instruction::MSTORE, // does not destroy memory knowledge
Instruction::DUP13, Instruction::DUP13,
u256(128 - 32), u256(128 - 32),
Instruction::MSTORE, // does not destoy memory knowledge Instruction::MSTORE, // does not destroy memory knowledge
u256(0x20), u256(0x20),
u256(12), u256(12),
Instruction::KECCAK256 // keccak256(m[12..(12+32)]) Instruction::KECCAK256 // keccak256(m[12..(12+32)])

View File

@ -329,7 +329,7 @@ BOOST_AUTO_TEST_CASE(trailing_dot_in_numbers)
BOOST_AUTO_TEST_CASE(leading_underscore_decimal_is_identifier) BOOST_AUTO_TEST_CASE(leading_underscore_decimal_is_identifier)
{ {
// Actual error is cought by SyntaxChecker. // Actual error is caught by SyntaxChecker.
CharStream stream("_1.2", ""); CharStream stream("_1.2", "");
Scanner scanner(stream); Scanner scanner(stream);
BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Identifier); BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Identifier);
@ -339,7 +339,7 @@ BOOST_AUTO_TEST_CASE(leading_underscore_decimal_is_identifier)
BOOST_AUTO_TEST_CASE(leading_underscore_decimal_after_dot_illegal) BOOST_AUTO_TEST_CASE(leading_underscore_decimal_after_dot_illegal)
{ {
// Actual error is cought by SyntaxChecker. // Actual error is caught by SyntaxChecker.
TestScanner scanner("1._2"); TestScanner scanner("1._2");
BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Number); BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Number);
BOOST_CHECK_EQUAL(scanner.next(), Token::EOS); BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);
@ -351,7 +351,7 @@ BOOST_AUTO_TEST_CASE(leading_underscore_decimal_after_dot_illegal)
BOOST_AUTO_TEST_CASE(leading_underscore_exp_are_identifier) BOOST_AUTO_TEST_CASE(leading_underscore_exp_are_identifier)
{ {
// Actual error is cought by SyntaxChecker. // Actual error is caught by SyntaxChecker.
CharStream stream("_1e2", ""); CharStream stream("_1e2", "");
Scanner scanner(stream); Scanner scanner(stream);
BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Identifier); BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Identifier);
@ -360,7 +360,7 @@ BOOST_AUTO_TEST_CASE(leading_underscore_exp_are_identifier)
BOOST_AUTO_TEST_CASE(leading_underscore_exp_after_e_illegal) BOOST_AUTO_TEST_CASE(leading_underscore_exp_after_e_illegal)
{ {
// Actual error is cought by SyntaxChecker. // Actual error is caught by SyntaxChecker.
CharStream stream("1e_2", ""); CharStream stream("1e_2", "");
Scanner scanner(stream); Scanner scanner(stream);
BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Number); BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Number);
@ -379,7 +379,7 @@ BOOST_AUTO_TEST_CASE(leading_underscore_hex_illegal)
BOOST_AUTO_TEST_CASE(fixed_number_invalid_underscore_front) BOOST_AUTO_TEST_CASE(fixed_number_invalid_underscore_front)
{ {
// Actual error is cought by SyntaxChecker. // Actual error is caught by SyntaxChecker.
CharStream stream("12._1234_1234", ""); CharStream stream("12._1234_1234", "");
Scanner scanner(stream); Scanner scanner(stream);
BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Number); BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Number);
@ -388,7 +388,7 @@ BOOST_AUTO_TEST_CASE(fixed_number_invalid_underscore_front)
BOOST_AUTO_TEST_CASE(number_literals_with_trailing_underscore_at_eos) BOOST_AUTO_TEST_CASE(number_literals_with_trailing_underscore_at_eos)
{ {
// Actual error is cought by SyntaxChecker. // Actual error is caught by SyntaxChecker.
TestScanner scanner("0x123_"); TestScanner scanner("0x123_");
BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Number); BOOST_CHECK_EQUAL(scanner.currentToken(), Token::Number);
BOOST_CHECK_EQUAL(scanner.next(), Token::EOS); BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);

View File

@ -168,7 +168,7 @@ bytes compileFirstExpression(
)); ));
context.appendMissingLowLevelFunctions(); context.appendMissingLowLevelFunctions();
// NOTE: We intentionally disable optimisations for utility functions to simplfy the tests // NOTE: We intentionally disable optimisations for utility functions to simplify the tests
context.appendYulUtilityFunctions({}); context.appendYulUtilityFunctions({});
BOOST_REQUIRE(context.appendYulUtilityFunctionsRan()); BOOST_REQUIRE(context.appendYulUtilityFunctionsRan());

View File

@ -3,7 +3,7 @@ pragma solidity >=0.8.0;
/// @dev Common mathematical functions used in both PRBMathSD59x18 and PRBMathUD60x18. Note that this shared library /// @dev Common mathematical functions used in both PRBMathSD59x18 and PRBMathUD60x18. Note that this shared library
/// does not always assume the signed 59.18-decimal fixed-point or the unsigned 60.18-decimal fixed-point /// does not always assume the signed 59.18-decimal fixed-point or the unsigned 60.18-decimal fixed-point
// representation. When it does not, it is annonated in the function's NatSpec documentation. // representation. When it does not, it is annotated in the function's NatSpec documentation.
library PRBMathCommon { library PRBMathCommon {
/// @dev How many trailing decimals can be represented. /// @dev How many trailing decimals can be represented.
uint256 internal constant SCALE = 1e18; uint256 internal constant SCALE = 1e18;

View File

@ -28,7 +28,7 @@ library PRBMathUD60x18 {
/// @notice Calculates arithmetic average of x and y, rounding down. /// @notice Calculates arithmetic average of x and y, rounding down.
/// @param x The first operand as an unsigned 60.18-decimal fixed-point number. /// @param x The first operand as an unsigned 60.18-decimal fixed-point number.
/// @param y The second operand as an unsigned 60.18-decimal fixed-point number. /// @param y The second operand as an unsigned 60.18-decimal fixed-point number.
/// @return result The arithmetic average as an usigned 60.18-decimal fixed-point number. /// @return result The arithmetic average as an unsigned 60.18-decimal fixed-point number.
function avg(uint256 x, uint256 y) internal pure returns (uint256 result) { function avg(uint256 x, uint256 y) internal pure returns (uint256 result) {
// The operations can never overflow. // The operations can never overflow.
unchecked { unchecked {