From 118fa1b7d3ca28eb18287aef73128a572d84264f Mon Sep 17 00:00:00 2001 From: Dimitris Apostolou Date: Thu, 12 Jan 2023 20:41:00 +0200 Subject: [PATCH] Fix typos --- .github/ISSUE_TEMPLATE/build_problem.md | 2 +- doc/config.md | 6 +++--- doc/cookie_deprecation.md | 2 +- doc/usage.md | 2 +- src/chain.rs | 2 +- src/config.rs | 2 +- src/status.rs | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/build_problem.md b/.github/ISSUE_TEMPLATE/build_problem.md index 5f9eff2..55a242a 100644 --- a/.github/ISSUE_TEMPLATE/build_problem.md +++ b/.github/ISSUE_TEMPLATE/build_problem.md @@ -46,5 +46,5 @@ Linking: static/dynamic Cross compilation: yes/no Target architecture: (uname -m on Linux if not cross-compiling) -**Aditional context** +**Additional context** Any additional information that seems to be relevant. diff --git a/doc/config.md b/doc/config.md index 788dae1..e38ec44 100644 --- a/doc/config.md +++ b/doc/config.md @@ -16,7 +16,7 @@ It's the most [secure](https://github.com/Kixunil/security_writings/blob/master/ Set `rpccookiefile` option of `bitcoind` to a file within an existing directory which it can access. You can skip it if you're running both daemons under the same user and with the default directories. -`electrs` will wait for `bitcoind` to sync, however, you will be unabe to use it until the syncing is done. +`electrs` will wait for `bitcoind` to sync, however, you will be unable to use it until the syncing is done. Example command for running `bitcoind` (assuming same user, default dirs): @@ -50,10 +50,10 @@ It is a good practice to use these special arguments at the beginning of the com **Naming convention** -For each command line argument an **environment variable** of the same name with `ELECTRS_` prefix, upper case letters and underscores instead of hypens exists +For each command line argument an **environment variable** of the same name with `ELECTRS_` prefix, upper case letters and underscores instead of hyphens exists (e.g. you can use `ELECTRS_ELECTRUM_RPC_ADDR` instead of `--electrum-rpc-addr`). -Similarly, for each such argument an option in config file exists with underscores instead of hypens (e.g. `electrum_rpc_addr`). +Similarly, for each such argument an option in config file exists with underscores instead of hyphens (e.g. `electrum_rpc_addr`). You need to use `true` value in case of flags (e.g. `timestamp = true`). diff --git a/doc/cookie_deprecation.md b/doc/cookie_deprecation.md index 65cb430..953dfc0 100644 --- a/doc/cookie_deprecation.md +++ b/doc/cookie_deprecation.md @@ -4,7 +4,7 @@ As of 0.8.8 the `cookie` option is deprecated and it will be removed. A new `auth` option was added. -If you don't use the `cookie` otpion, you're not affected and don't need to read this. +If you don't use the `cookie` option, you're not affected and don't need to read this. Note that this is different from `cookie_file`. ## Why? diff --git a/doc/usage.md b/doc/usage.md index fd61645..7b9c736 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -59,7 +59,7 @@ Config { network: Bitcoin, db_path: "./db/bitcoin", daemon_dir: "/home/user/.bit You can specify options via command-line parameters, environment variables or using config files. See the documentation above. -Note that the final DB size should be ~10% of the `blk*.dat` files, but it may increase to ~20% at the end of the inital sync (just before the [full compaction is invoked](https://github.com/facebook/rocksdb/wiki/Manual-Compaction)). +Note that the final DB size should be ~10% of the `blk*.dat` files, but it may increase to ~20% at the end of the initial sync (just before the [full compaction is invoked](https://github.com/facebook/rocksdb/wiki/Manual-Compaction)). It should take roughly 18 hours to sync and compact the index on an ODROID-HC1 with 8 CPU cores @ 2GHz, 2GB RAM, and an SSD using the command above. diff --git a/src/chain.rs b/src/chain.rs index 9d0dc40..0e833bf 100644 --- a/src/chain.rs +++ b/src/chain.rs @@ -56,7 +56,7 @@ impl Chain { ))]) } - /// Load the chain from a collecion of headers, up to the given tip + /// Load the chain from a collection of headers, up to the given tip pub(crate) fn load(&mut self, headers: Vec, tip: BlockHash) { let genesis_hash = self.headers[0].0; diff --git a/src/config.rs b/src/config.rs index cb90796..4044ab8 100644 --- a/src/config.rs +++ b/src/config.rs @@ -291,7 +291,7 @@ impl Config { Auth::UserPass(parts[0].to_owned(), parts[1].to_owned()) } (Some(_), Some(_)) => { - eprintln!("Error: ambigous configuration - auth and cookie_file can't be specified at the same time"); + eprintln!("Error: ambiguous configuration - auth and cookie_file can't be specified at the same time"); std::process::exit(1); } }); diff --git a/src/status.rs b/src/status.rs index ac577d9..661c4fb 100644 --- a/src/status.rs +++ b/src/status.rs @@ -124,7 +124,7 @@ impl HistoryEntry { /// ScriptHash subscription status pub struct ScriptHashStatus { - scripthash: ScriptHash, // specfic scripthash to be queried + scripthash: ScriptHash, // specific scripthash to be queried tip: BlockHash, // used for skipping confirmed entries' sync confirmed: HashMap>, // confirmed entries, partitioned per block (may contain stale blocks) mempool: Vec, // unconfirmed entries