Skip to content
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

Fix typos #756

Merged
merged 1 commit into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions cargo-crev/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

## [0.24.0](https://github.com/crev-dev/cargo-crev/compare/v0.23.0...v0.24.3)

- Added `--direct` flag to trust paramaters to use only directly trusted Ids
- Added `--direct` flag to trust parameters to use only directly trusted Ids
- Added command "proof reissue" to reissue reviews under a different id.
The original proof will be referenced in the new proof under the "original:" field
- Fix crash on systems with libgit2 v1.4
Expand Down Expand Up @@ -183,7 +183,7 @@ improvements
- **BREAKING**: `cargo crev <verb> <noun>` was change to `cargo crev <noun>
<verb>`
- Introduces one letter aliases for most (all?) commands
- Commands quering proofs will now print them as a multi-object yaml document
- Commands querying proofs will now print them as a multi-object yaml document
for easier parsing
- Shortened `=1.2.3` in `latest_t` to just `=`

Expand All @@ -194,7 +194,7 @@ improvements
- `crate mvp` to discovering best reviewers
- `crate search` for looking up best reviewed dependency candidates
- `crate verify --recursive`
- `CREV_PASSPHRASE_CMD` for users of `pass` and similiar
- `CREV_PASSPHRASE_CMD` for users of `pass` and similar
- Multiple flags and arguments to narrow down `crate verify` scope
- Handling of `--level <level>` in many commands
- "Tips and tricks" in user
Expand Down Expand Up @@ -228,7 +228,7 @@ documentation
- User Documentation, including Getting Started Guide
- `query dir` command
- Differential reviews with `diff` and `review --diff` commands
- New options, particularily for
- New options, particularly for
`verify`

## [0.7.0](https://github.com/dpc/crev/compare/cargo-crev-v0.6.0...cargo-crev-v0.7.0) - 2019-04-27
Expand Down
2 changes: 1 addition & 1 deletion cargo-crev/src/deps/print_term.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Functions related to writeing dependencies in the standard
// Functions related to writing dependencies in the standard
// terminal (not in the context of a real terminal application)

use super::*;
Expand Down
6 changes: 3 additions & 3 deletions cargo-crev/src/doc/advisories.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ Each issue is marked with an ID. It can be any string. Identifiers like
URL can be used instead.

Issues associated with a crate version, are only stating that this particular
release is affected. The do not imply that this is neccesarily the first or only
release is affected. The do not imply that this is necessarily the first or only
version being affected.

Also, issues are treated as an open from the first version reported. `crev` will
consider all the later versions to be affected as well, until a corresponding
*advisory* is found with a matching `id`.

**It is generaly better to report *advisories* instead of issues**. Issues are
**It is generally better to report *advisories* instead of issues**. Issues are
most useful when the fixed release is not yet available, so it's impossible to
create an advisory associated with a version that does not yet exist.

Expand All @@ -43,7 +43,7 @@ released in the version 1.4.5, a `range: minor` since the whole minor release
was affected (all versions matching 1.4.x, before release containing the
advisory).

This simplifies specifing the range, but is not always precise. Had the issue
This simplifies specifying the range, but is not always precise. Had the issue
been first introduced in version 1.4.1, the version 1.4.0 would be incorrectly
affected as well. This is however rare and overshooting is not a problem.

Expand Down
12 changes: 6 additions & 6 deletions cargo-crev/src/doc/cargo_specific.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Cargo specific features

`crev` is a language and ecosystem agnostic system for reviewing code. While
being quite generic it does not forbit or prevent integrating with particular
being quite generic it does not forbid or prevent integrating with particular
features and data available in each ecosystem. Quite the opposite - part of the
vision of `crev` is to build well integrated ecosystem-specific tools.
`cargo-crev` is exactly such a tool for Rust language and `cargo` package
Expand All @@ -16,19 +16,19 @@ and/or rely on other reputable reviewers, this will be a difficult target until
a critical mass of adoption is reached.

To address this problem, `cargo-crev` allows reasoning about trustworthinnes of
crates by the reputation of their autors.
crates by the reputation of their authors.

Every crev identity can create and maintain a "known owners" list. Use `cargo
crev config edit known` command to edit it. Each line is crates.io username or
group name that will be considered somewhat trustwothy.
group name that will be considered somewhat trustworthy.

During dependency verification a `--skip-known-owners` argument can be used to
skip crates that have at least one known owner.

It's important to consider the security implications. crates.io or the personal
accounts of reputable crate authors could get compromised. And just because the
crate owner is on a list of authors does not mean other co-authors are
neccessarily trustworthy.
necessarily trustworthy.

So this feature is definitely a compromise. But it is very useful for filtering
out dependencies that are most probably OK, and can be reviewed after code from
Expand All @@ -38,7 +38,7 @@ less reputable sources is reviewed first.

`cargo crev crate verify` will display download counts for both specific crate
version and total crate downloads, as a quick estimate of crate popularity.
Crates and versions with particularily low download count at higher risk of
Crates and versions with particularly low download count at higher risk of
introducing serious bugs or malicious code.

## Geiger count
Expand All @@ -53,5 +53,5 @@ the code.

`cargo-crev` uses [`tokei`](https://crates.io/crates/tokei) to calculate the
total number of Rust code each dependency introduces. Small crates are a good
candidate for imediate review (because it will be quick). Bigger ones can often
candidate for immediate review (because it will be quick). Bigger ones can often
be replaced with smaller alternatives.
4 changes: 2 additions & 2 deletions cargo-crev/src/doc/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ Example. VSCode users can run:
$ cargo crev open <crate> --cmd "code --wait -n" --cmd-save
```

`--cmd-save` will make `crev` remember the `--cmd` paramter in the future, so it
`--cmd-save` will make `crev` remember the `--cmd` parameter in the future, so it
does not have to be repeated every time. The exact `--cmd` to use for each IDE
can vary, and you can ask for help in figuring it out on the `crev`'s gitter
channel. You can change the command later with `cargo crev config edit`.
Expand Down Expand Up @@ -396,7 +396,7 @@ comment: ""
# and trustworthiness.
#
# Your Proofs are cryptographically signed and will circulate in the ecosystem.
# While there is no explicit or implicity legal responsibiltity attached to
# While there is no explicit or implicitly legal responsibiltity attached to
# using `crev` system, other people will most probably use it to judge you,
# your other work, etc.
#
Expand Down
4 changes: 2 additions & 2 deletions cargo-crev/src/doc/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The following is glossary of terms commonly used in `crev` and `cargo-crev`
An optional part of a *Review*, announcing a significant problem fixed in that
package version, advising other users to upgrade.

Notably *Advisories* implicitly denote existance of such issue in all previous
Notably *Advisories* implicitly denote existence of such issue in all previous
versions in a certain *VersionRange*.

### *CrevId*
Expand All @@ -23,7 +23,7 @@ the secret key stored locally and encrypted with a passphrase.
An optional part of a *Review*, announcing a significant problem present in a
given package version.

Very similiar to *Advisory*. It's generally better to prefer *Advisories*,
Very similar to *Advisory*. It's generally better to prefer *Advisories*,
except for cases in which the problem does not have a solution available yet.

### *Level*
Expand Down
2 changes: 1 addition & 1 deletion cargo-crev/src/doc/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/// and [Glossary](`self::user::glossary`) modules.
///
/// Please be aware that all user documentation is
/// a continous work in progress, and can be incorrect
/// a continuous work in progress, and can be incorrect
/// or stale.
///
/// Writing high quality documentation is
Expand Down
2 changes: 1 addition & 1 deletion cargo-crev/src/doc/organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ reviews.

Depending on the code review policy, proofs created by individual contributors
can be internal, or publicly available. Sharing code reviews with wider
community can be a proof of a concious approach to security, and a form of
community can be a proof of a conscious approach to security, and a form of
giving back to the community.

## Enforcing code review policy
Expand Down
2 changes: 1 addition & 1 deletion cargo-crev/src/doc/tips_and_tricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Check the `cargo crev crate verify --help` output for more helpful flags.
0 unicode-segmentation
```

`cargo crev crate search <query>` will query crates.io for crate maching a given
`cargo crev crate search <query>` will query crates.io for crate matching a given
query, and then sort them from the most trustworthy.

This features is still new and is planed to be expanded and improved.
2 changes: 1 addition & 1 deletion cargo-crev/src/doc/trust.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Or in other words: for R to have a given *effective trust* for Y, there has to
exist at least on path from R and Y, where every previous node directly trusts
the next one at the level at least as high.

That's because any *effective trust level* can only be as high as the higest
That's because any *effective trust level* can only be as high as the highest
*effective trust level*

### Depth of the WoT
Expand Down
6 changes: 3 additions & 3 deletions cargo-crev/src/edit.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ fn get_editor_to_use() -> Result<ffi::OsString> {
})
}

/// Retruns the edited string, and bool indicating if the file was ever written to/ (saved).
/// Returns the edited string, and bool indicating if the file was ever written to/ (saved).
fn edit_text_iteractively_raw(text: &str) -> Result<(String, bool)> {
let dir = tempfile::tempdir()?;
let file_path = dir.path().join("crev.review.yaml");
Expand All @@ -51,7 +51,7 @@ pub fn edit_text_iteractively(text: &str) -> Result<String> {
Ok(edit_text_iteractively_raw(text)?.0)
}

pub fn edit_text_iteractively_until_writen_to(text: &str) -> Result<String> {
pub fn edit_text_iteractively_until_written_to(text: &str) -> Result<String> {
loop {
let (text, modified) = edit_text_iteractively_raw(text)?;
if !modified {
Expand Down Expand Up @@ -120,7 +120,7 @@ pub fn edit_proof_content_iteractively<C: proof::ContentWithDraft>(
writeln!(&mut text, "# {line}")?;
}
loop {
text = edit_text_iteractively_until_writen_to(&text)?;
text = edit_text_iteractively_until_written_to(&text)?;
match content.apply_draft(&text) {
Err(e) => {
eprintln!("There was an error parsing content: {e}");
Expand Down
2 changes: 1 addition & 1 deletion cargo-crev/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -721,7 +721,7 @@ fn run_command(command: opts::Command) -> Result<CommandExitStatus> {
maybe_store(&local, &proof, commit_msg, &args.common)?;
}
Err(e) => {
eprintln!("Ignoried unknwon proof - {e}");
eprintln!("Ignoried unknown proof - {e}");
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions cargo-crev/src/opts.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use crate::term::Term;

#[derive(Debug, StructOpt, Clone, Default)]
pub struct CrateSelector {
/// This crate is not neccesarily a dependency of the current cargo project
/// This crate is not necessarily a dependency of the current cargo project
#[structopt(long = "unrelated", short = "u")]
pub unrelated: bool,

Expand Down Expand Up @@ -213,7 +213,7 @@ pub struct Diff {
#[structopt(long = "dst")]
pub dst: Option<Version>,

/// This crate is not neccesarily a dependency of the current cargo project
/// This crate is not necessarily a dependency of the current cargo project
#[structopt(long = "unrelated", short = "u")]
pub unrelated: bool,

Expand Down
6 changes: 3 additions & 3 deletions cargo-crev/src/wot.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ pub fn print_log(wot_opts: WotOpts) -> Result<()> {
write!(io::stdout(), "; ")?;
term.print(format_args!("distrusted"), RED)?;
}
if edge.ignored_overriden {
if edge.ignored_overridden {
write!(io::stdout(), "; ")?;
term.print(format_args!("overriden"), YELLOW)?;
write!(io::stdout(), " by {}", edge.overriden_by.iter().join(", "))?;
term.print(format_args!("overridden"), YELLOW)?;
write!(io::stdout(), " by {}", edge.overridden_by.iter().join(", "))?;
}
if edge.ignored_too_far {
write!(io::stdout(), "; ")?;
Expand Down
2 changes: 1 addition & 1 deletion crev-data/src/id.rs
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ impl Id {
}
}

/// A unique ID accompanied by publically identifying data.
/// A unique ID accompanied by publicly identifying data.
#[derive(Clone, Debug, Builder, Serialize, Deserialize, PartialEq, Eq, Hash)]
pub struct PublicId {
#[serde(flatten)]
Expand Down
2 changes: 1 addition & 1 deletion crev-data/src/proof/content.rs
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ where
///
/// A simplified version of content, used
/// for user interaction - editing the parts
/// that are not neccessary for the user to see.
/// that are not necessary for the user to see.
pub struct Draft {
pub(crate) title: String,
pub(crate) body: String,
Expand Down
2 changes: 1 addition & 1 deletion crev-data/src/proof/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ pub struct Proof {
/// Signature over the body
signature: String,

/// Common informations that should be in any proof
/// Common information that should be in any proof
common_content: Common,

/// Digest (blake2b256)
Expand Down
2 changes: 1 addition & 1 deletion crev-data/src/proof/review/package.rs
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ impl Advisory {
/// a problem with package in a given version. It leaves the
/// question open if any previous and following versions might
/// also be affected, but will be considered open and affecting
/// all following versions withing the `range` until an advisory
/// all following versions within the `range` until an advisory
/// is found for it, matching the id.
#[derive(Clone, TypedBuilder, Debug, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
Expand Down
2 changes: 1 addition & 1 deletion crev-lib/rc/doc/editing-trust.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Example reasons *NOT* to use distrust level:
self-reported `thoroughness` and `understanding` levels are truthful,
such reviews are still beneficial to the community and it's up to other
users to filter them out with `--thoroughness X` and `--understanding X`
flags if they don't want ot use them.
flags if they don't want to use them.
* Users review criteria don't match my higher quality standards. Again,
within reason that does not endanger the community, it is a
reasponsibility of other users to assign lower trust levels to parties
Expand Down
6 changes: 3 additions & 3 deletions crev-lib/src/local.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ fn generete_salt() -> Vec<u8> {
/// `host_salt` was not a thing - generate some
/// form of stable id
///
/// TODO: at some point this should no longer be neccessary
/// TODO: at some point this should no longer be necessary
fn backfill_salt() -> Vec<u8> {
crev_common::blake2b256sum(b"BACKFILLED_SUM").to_vec()
}
Expand Down Expand Up @@ -820,13 +820,13 @@ impl Local {
Ok(from_id.create_trust_proof(&public_ids, trust_level, override_)?)
}

/// Fetch other people's proof repostiory from a git URL, into the current database on disk
/// Fetch other people's proof repository from a git URL, into the current database on disk
pub fn fetch_url(&self, url: &str) -> Result<()> {
let mut db = self.load_db()?;
self.fetch_url_into(url, &mut db)
}

/// Fetch other people's proof repostiory from a git URL, directly into the given db (and disk too)
/// Fetch other people's proof repository from a git URL, directly into the given db (and disk too)
pub fn fetch_url_into(&self, url: &str, db: &mut crev_wot::ProofDB) -> Result<()> {
info!("Fetching {}... ", url);
let dir = self.fetch_remote_git(url)?;
Expand Down
2 changes: 1 addition & 1 deletion crev-lib/src/proof.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pub(crate) fn rel_store_path(proof: &proof::Proof, host_salt: &[u8]) -> PathBuf
date,
type_subname,
// this used to be `[..4]`, but temporarily change it
// to accomodate a new proof format. old clients will
// to accommodate a new proof format. old clients will
// fail to parse a whole file if it contains a new proof
// format, so this makes sure new proofs are only
// in separate files; this can be reverted back after
Expand Down
2 changes: 1 addition & 1 deletion crev-lib/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use crev_wot::{FetchSource, ProofDB};
use default::default;
use std::{str::FromStr, sync::Arc};

// Basic liftime of an `LockedId`:
// Basic lifetime of an `LockedId`:
//
// * generate
// * lock with a passphrase
Expand Down
2 changes: 1 addition & 1 deletion crev-wot/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -662,7 +662,7 @@ impl ProofDB {
// This is one of the most complicated calculations in whole crev. I hate this code
// already, and I have barely put it together.

// Here we track all the reported isue by issue id
// Here we track all the reported issue by issue id
let mut issue_reports_by_id: HashMap<String, IssueDetails> = HashMap::new();

// First we go through all the reports in previous versions with `issues` fields and collect these.
Expand Down
2 changes: 1 addition & 1 deletion crev-wot/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ fn proofdb_distance() -> Result<()> {
// should be visible in all the user-facing stats, listings
// and counts.
#[test]
fn overwritting_reviews() -> Result<()> {
fn overwriting_reviews() -> Result<()> {
let url = FetchSource::Url(Arc::new(Url::new_git("https://a")));
let a = UnlockedId::generate_for_git_url("https://a");
let digest = [0; 32];
Expand Down
Loading
Loading