Skip to content

Commit

Permalink
Fix typos (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
nnsW3 committed Dec 8, 2023
1 parent 920a093 commit b521275
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Provide a clear and concise description of the bug.

#### 🔄 Reproduction Steps

Steps to reproduce the behaviour
Steps to reproduce the behavior

#### 🤔 Expected Behavior

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ There are many ways to contribute to the ZK Stack:
To contribute code fixing issues, please fork the repo, fix an issue, commit, add documentation as per the PR template,
and the repo's maintainers will review the PR.
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
for guidance how to work with PRs created from a fork.
for guidance on how to work with PRs created from a fork.

## Licenses

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ write smart contracts in C++, Rust and other popular languages.
bellman-cuda is a library implementing GPU-accelerated cryptographic functionality for the zkSync prover.

### Building the library
The library can be build by executing these steps:
The library can be built by executing these steps:

#### Initialize git submodules
`git submodule update --init --recursive`
Expand All @@ -21,7 +21,7 @@ The library can be build by executing these steps:

The library binary can be found in the `./build/src` folder. Change the path in the above commands if a different build location is desired.

By default, the library is build for Compute Architecture 8.0.
By default, the library is built for Compute Architecture 8.0.
If a different Compute Architecture is required, the [CMAKE_CUDA_ARCHITECTURES](https://cmake.org/cmake/help/latest/variable/CMAKE_CUDA_ARCHITECTURES.html) variables can be set to the desired architecture(s) during the build configuration generation step.

Example for Compute Architecture 8.6:
Expand Down Expand Up @@ -60,6 +60,6 @@ at your option.
## Disclaimer

zkSync Era has been through lots of testing and audits. Although it is live, it is still in alpha state and will go
through more audits and bug bounties programs. We would love to hear our community's thoughts and suggestions about it!
through more audits and bug bounty programs. We would love to hear our community's thoughts and suggestions about it!
It is important to state that forking it now can potentially lead to missing important security updates, critical
features, and performance improvements.
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Security Policy

We truly appreciate efforts to discover and disclose security issues responsibly!
We truly appreciate your efforts to discover and disclose security issues responsibly!

## Vulnerabilities

Expand Down
6 changes: 3 additions & 3 deletions src/bellman-cuda.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ extern "C" {
typedef enum bc_error {
bc_success = 0, // The API call returned with no errors. In the case of query calls,
// this also means that the operation being queried is complete (see bc_event_query() and bc_stream_query()).
bc_error_invalid_value = 1, // This indicates that one or more of the parameters passed to the API call is not within an acceptable range of values.
bc_error_invalid_value = 1, // This indicates that one or more of the parameters passed to the API call are not within an acceptable range of values.
bc_error_memory_allocation = 2, // The API call failed because it was unable to allocate enough memory to perform the requested operation.
bc_error_not_ready = 600 // This indicates that asynchronous operations issued previously have not completed yet. This result is not actually an error,
bc_error_not_ready = 600 // This indicates that asynchronous operations issued previously have not been completed yet. This result is not actually an error,
// but must be indicated differently than bc_success (which indicates completion). Calls that may return this value include
// bc_event_query() and bc_stream_query().
} bc_error;
Expand Down Expand Up @@ -67,7 +67,7 @@ bc_error bc_stream_synchronize(bc_stream stream);

// Queries an asynchronous stream for completion status.
// stream - Stream identifier
// Returns bc_success if all operations in stream have completed, or bc_error_not_ready if not.
// Returns bc_success if all operations in stream have been completed, or bc_error_not_ready if not.
bc_error bc_stream_query(bc_stream stream);

// Destroys and cleans up an asynchronous stream.
Expand Down
2 changes: 1 addition & 1 deletion src/ff_dispatch_st.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ template <class FF_CONFIG, const uint32_t &INV> struct ff_dispatch_st {
} else {
even[0] = ptx::add_cc(even[0], odd[1]);
// we trust the compiler to *not* touch the carry flag here
// this code sits in between two "asm volatile" instructions witch should guarantee that nothing else interferes wit the carry flag
// this code sits in between two "asm volatile" instructions which should guarantee that nothing else interferes with the carry flag
mi = even[0] * INV;
madc_n_rshift(odd, MOD + 1, mi);
cmad_n(even, MOD, mi);
Expand Down
2 changes: 1 addition & 1 deletion src/ntt_kernels.cu
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ cudaError_t set_up_powers() {
* C-T can straightforwardly meet both requirements.
*
* Cooley-Tukey does not sacrifice performance.
* Using careful shared memory marshalling, the kernels below carry out
* Using careful shared memory marshaling, the kernels below carry out
* up to 10 exchange stages at a time for each gmem read+write of the data.
*/

Expand Down

0 comments on commit b521275

Please sign in to comment.