From 45e36889aa4bdd3581d80c8275a74471a2f4553c Mon Sep 17 00:00:00 2001 From: Lyndon Date: Fri, 1 Aug 2025 10:06:05 +0800 Subject: [PATCH] chore: typos found by https://github.com/crate-ci/typos --- README.md | 6 +++--- atomics-contract/Makefile | 4 ++-- contract-without-simulator/Makefile | 4 ++-- contract/Makefile | 4 ++-- stack-reorder-contract/Makefile | 4 ++-- standalone-contract/Makefile | 4 ++-- workspace/Makefile | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 22de89c..fad96b9 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ The following dependencies are required for the templates: * `git`, `make`, `sed`, `bash`, `shasum` and others Unix utilities. Refer to the documentation for your operating systems for how to install them. Chances are your system might already have them. * `Rust`: latest stable Rust installed via [rustup](https://rustup.rs/) should work. Make sure you have `riscv64` target installed via: `rustup target add riscv64imac-unknown-none-elf` -* `Clang`: make sure you have clang 18+ installed, sample installtion steps for selected platforms are: +* `Clang`: make sure you have clang 18+ installed, sample installation steps for selected platforms are: + Debian / Ubuntu: `wget https://apt.llvm.org/llvm.sh && chmod +x llvm.sh && sudo ./llvm.sh 18 && rm llvm.sh` + Fedora 39+: `sudo dnf -y install clang` + Archlinux: `sudo pacman --noconfirm -Syu clang` @@ -144,10 +144,10 @@ $ make generate TEMPLATE=c-wrapper-crate DESTINATION=crates # generate a crat Ready-to-use templates have been put together for different use cases: -* `contract`: default contract template you should use if no special requirements are neeeded. +* `contract`: default contract template you should use if no special requirements are needed. * `stack-reorder-contract`: a contract template that adjusts memory layout so stack lives at lower address, and heap lives at higher address. This way a program would explicitly signal errors when stack space is fully use. * `c-wrapper-crate`: a crate template that shows how to glue C code in a Rust crate for CKB's contract usage. -* `x64-simulator-crate`: a crate template that contains Rust-only code, but usees [ckb-x64-simulator](https://github.com/nervosnetwork/ckb-x64-simulator) for tests. +* `x64-simulator-crate`: a crate template that contains Rust-only code, but uses [ckb-x64-simulator](https://github.com/nervosnetwork/ckb-x64-simulator) for tests. There are also deprecated templates kept for historical reasons. diff --git a/atomics-contract/Makefile b/atomics-contract/Makefile index 2890edb..3c44e83 100644 --- a/atomics-contract/Makefile +++ b/atomics-contract/Makefile @@ -16,7 +16,7 @@ FULL_RUSTFLAGS := -C target-feature=+zba,+zbb,+zbc,+zbs,-a $(CUSTOM_RUSTFLAGS) CARGO_ARGS := MODE := release # Tweak this to change the clang version to use for building C code. By default -# we use a bash script with somes heuristics to find clang in current system. +# we use a bash script with some heuristics to find clang in current system. CLANG := $(shell $(TOP)/scripts/find_clang) AR := $(subst clang,llvm-ar,$(CLANG)) # When this is set to some value, the generated binaries will be copied over @@ -61,7 +61,7 @@ fmt: # Arbitrary cargo command is supported here. For example: # # make cargo CARGO_CMD=expand CARGO_ARGS="--ugly" -# +# # Invokes: # cargo expand --ugly CARGO_CMD := diff --git a/contract-without-simulator/Makefile b/contract-without-simulator/Makefile index e1112c6..e311b51 100644 --- a/contract-without-simulator/Makefile +++ b/contract-without-simulator/Makefile @@ -16,7 +16,7 @@ FULL_RUSTFLAGS := -C target-feature=+zba,+zbb,+zbc,+zbs,-a $(CUSTOM_RUSTFLAGS) CARGO_ARGS := MODE := release # Tweak this to change the clang version to use for building C code. By default -# we use a bash script with somes heuristics to find clang in current system. +# we use a bash script with some heuristics to find clang in current system. CLANG := $(shell $(TOP)/scripts/find_clang) AR := $(subst clang,llvm-ar,$(CLANG)) OBJCOPY := $(subst clang,llvm-objcopy,$(CLANG)) @@ -64,7 +64,7 @@ fmt: # Arbitrary cargo command is supported here. For example: # # make cargo CARGO_CMD=expand CARGO_ARGS="--ugly" -# +# # Invokes: # cargo expand --ugly CARGO_CMD := diff --git a/contract/Makefile b/contract/Makefile index e1112c6..e311b51 100644 --- a/contract/Makefile +++ b/contract/Makefile @@ -16,7 +16,7 @@ FULL_RUSTFLAGS := -C target-feature=+zba,+zbb,+zbc,+zbs,-a $(CUSTOM_RUSTFLAGS) CARGO_ARGS := MODE := release # Tweak this to change the clang version to use for building C code. By default -# we use a bash script with somes heuristics to find clang in current system. +# we use a bash script with some heuristics to find clang in current system. CLANG := $(shell $(TOP)/scripts/find_clang) AR := $(subst clang,llvm-ar,$(CLANG)) OBJCOPY := $(subst clang,llvm-objcopy,$(CLANG)) @@ -64,7 +64,7 @@ fmt: # Arbitrary cargo command is supported here. For example: # # make cargo CARGO_CMD=expand CARGO_ARGS="--ugly" -# +# # Invokes: # cargo expand --ugly CARGO_CMD := diff --git a/stack-reorder-contract/Makefile b/stack-reorder-contract/Makefile index 48c9954..867e29a 100644 --- a/stack-reorder-contract/Makefile +++ b/stack-reorder-contract/Makefile @@ -17,7 +17,7 @@ FULL_RUSTFLAGS := -C target-feature=+zba,+zbb,+zbc,+zbs,-a $(CUSTOM_RUSTFLAGS) \ CARGO_ARGS := MODE := release # Tweak this to change the clang version to use for building C code. By default -# we use a bash script with somes heuristics to find clang in current system. +# we use a bash script with some heuristics to find clang in current system. CLANG := $(shell $(TOP)/scripts/find_clang) AR := $(subst clang,llvm-ar,$(CLANG)) # When this is set to some value, the generated binaries will be copied over @@ -72,7 +72,7 @@ fmt: # Arbitrary cargo command is supported here. For example: # # make cargo CARGO_CMD=expand CARGO_ARGS="--ugly" -# +# # Invokes: # cargo expand --ugly CARGO_CMD := diff --git a/standalone-contract/Makefile b/standalone-contract/Makefile index 14d827c..8e2d8f9 100644 --- a/standalone-contract/Makefile +++ b/standalone-contract/Makefile @@ -16,7 +16,7 @@ FULL_RUSTFLAGS := -C target-feature=+zba,+zbb,+zbc,+zbs,-a $(CUSTOM_RUSTFLAGS) CARGO_ARGS := MODE := release # Tweak this to change the clang version to use for building C code. By default -# we use a bash script with somes heuristics to find clang in current system. +# we use a bash script with some heuristics to find clang in current system. CLANG := $(shell $(TOP)/scripts/find_clang) AR := $(subst clang,llvm-ar,$(CLANG)) # When this is set to some value, the generated binaries will be copied over @@ -62,7 +62,7 @@ fmt: # Arbitrary cargo command is supported here. For example: # # make cargo CARGO_CMD=expand CARGO_ARGS="--ugly" -# +# # Invokes: # cargo expand --ugly CARGO_CMD := diff --git a/workspace/Makefile b/workspace/Makefile index 71fbbc1..36a9c7e 100644 --- a/workspace/Makefile +++ b/workspace/Makefile @@ -13,7 +13,7 @@ CUSTOM_RUSTFLAGS := -C debug-assertions CARGO_ARGS := MODE := release # Tweak this to change the clang version to use for building C code. By default -# we use a bash script with somes heuristics to find clang in current system. +# we use a bash script with some heuristics to find clang in current system. CLANG := $(shell $(TOP)/scripts/find_clang) # When this is set, a single contract will be built instead of all contracts CONTRACT :=