renamed gendoc to gencode; make it unpublishable (#260)
This commit is contained in:
parent
dc3544e5d9
commit
e5ecb2d3f4
|
@ -38,10 +38,10 @@ jobs:
|
||||||
run: cargo install cargo-llvm-cov
|
run: cargo install cargo-llvm-cov
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: cargo llvm-cov --lcov --no-report --ignore-filename-regex 'tests.rs|benches.rs|gendoc'
|
run: cargo llvm-cov --lcov --no-report --ignore-filename-regex 'tests.rs|benches.rs|gencode'
|
||||||
|
|
||||||
- name: Generate coverage report
|
- name: Generate coverage report
|
||||||
run: cargo llvm-cov report --lcov --ignore-filename-regex 'tests.rs|benches.rs|gendoc' --output-path lcov.info
|
run: cargo llvm-cov report --lcov --ignore-filename-regex 'tests.rs|benches.rs|gencode' --output-path lcov.info
|
||||||
|
|
||||||
- name: Upload coverage report to Codecov
|
- name: Upload coverage report to Codecov
|
||||||
uses: codecov/codecov-action@v3.1.1
|
uses: codecov/codecov-action@v3.1.1
|
||||||
|
|
|
@ -88,7 +88,7 @@ jobs:
|
||||||
- uses: actions-rs/cargo@v1.0.3
|
- uses: actions-rs/cargo@v1.0.3
|
||||||
with:
|
with:
|
||||||
command: run
|
command: run
|
||||||
args: --bin gendoc -- --check
|
args: --bin gencode -- --check
|
||||||
|
|
||||||
docs:
|
docs:
|
||||||
name: Check Rust doc
|
name: Check Rust doc
|
||||||
|
|
|
@ -8,5 +8,5 @@ members = [
|
||||||
"frost-ristretto255",
|
"frost-ristretto255",
|
||||||
"frost-secp256k1",
|
"frost-secp256k1",
|
||||||
"frost-rerandomized",
|
"frost-rerandomized",
|
||||||
"gendoc"
|
"gencode"
|
||||||
]
|
]
|
||||||
|
|
|
@ -41,4 +41,4 @@ dependency.
|
||||||
Test coverage checks are performed in the pipeline. This is cofigured here: `.github/workflows/coverage.yaml`
|
Test coverage checks are performed in the pipeline. This is cofigured here: `.github/workflows/coverage.yaml`
|
||||||
To run these locally:
|
To run these locally:
|
||||||
1. Install coverage tool by running `cargo install cargo-llvm-cov`
|
1. Install coverage tool by running `cargo install cargo-llvm-cov`
|
||||||
2. Run `cargo llvm-cov --ignore-filename-regex 'tests.rs|benches.rs|gendoc'` (you may be asked if you want to install `llvm-tools-preview`, if so type `Y`)
|
2. Run `cargo llvm-cov --ignore-filename-regex 'tests.rs|benches.rs|gencode'` (you may be asked if you want to install `llvm-tools-preview`, if so type `Y`)
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
[package]
|
[package]
|
||||||
name = "gendoc"
|
name = "gencode"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
|
publish = false
|
||||||
|
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
|
@ -9,7 +10,7 @@ edition = "2021"
|
||||||
regex = "1.6.0"
|
regex = "1.6.0"
|
||||||
|
|
||||||
[[bin]]
|
[[bin]]
|
||||||
name = "gendoc"
|
name = "gencode"
|
||||||
path = "src/main.rs"
|
path = "src/main.rs"
|
||||||
# Disables non-criterion benchmark which is not used; prevents errors
|
# Disables non-criterion benchmark which is not used; prevents errors
|
||||||
# when using criterion-specific flags
|
# when using criterion-specific flags
|
|
@ -1,5 +1,7 @@
|
||||||
//! Generate documentation for a ciphersuite based on another ciphersuite implementation.
|
//! Generate documentation for a ciphersuite based on another ciphersuite implementation.
|
||||||
//!
|
//!
|
||||||
|
//! This is an internal tool used for development.
|
||||||
|
//!
|
||||||
//! The documentation for each ciphersuite is very similar, with the only difference being
|
//! The documentation for each ciphersuite is very similar, with the only difference being
|
||||||
//! the ciphersuite name.
|
//! the ciphersuite name.
|
||||||
//!
|
//!
|
||||||
|
@ -8,7 +10,7 @@
|
||||||
//! uses frost-ristretto255 as the "canonical" one, so:
|
//! uses frost-ristretto255 as the "canonical" one, so:
|
||||||
//!
|
//!
|
||||||
//! - Change any documentation of a public function or struct in `frost-ristretto255/src/lib.rs`
|
//! - Change any documentation of a public function or struct in `frost-ristretto255/src/lib.rs`
|
||||||
//! - Run `cargo run --manifest-path gendoc/Cargo.toml` to update the documentation
|
//! - Run `cargo run --manifest-path gencode/Cargo.toml` to update the documentation
|
||||||
//! of the other ciphersuites.
|
//! of the other ciphersuites.
|
||||||
|
|
||||||
use std::{env, fs, iter::zip, process::ExitCode};
|
use std::{env, fs, iter::zip, process::ExitCode};
|
Loading…
Reference in New Issue