From 57a0436ca10a0094863c05a5a2508659d6b7e377 Mon Sep 17 00:00:00 2001 From: Mario Voigt Date: Sat, 14 Dec 2024 21:54:01 +0100 Subject: [PATCH] fix typo; fixes https://gitlab.com/fabinfra/fabaccess/bffh/-/issues/68 --- CONTRIBUTING.md | 2 +- INSTALL.md | 8 ++++---- README.md | 4 ++-- bffhd/lib.rs | 6 +++--- bin/bffhd/main.rs | 20 ++++++++++---------- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9836afd..9eea7d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,7 +56,7 @@ But before you open an issue in this repo for a feature request, please first ch ## Contributing Code -To help develop Diflouroborane you will need a Rust toolchain. I heavily recommend installing +To help develop Difluoroborane you will need a Rust toolchain. I heavily recommend installing [rustup](https://rustup.rs) even if your distribution provides a recent enough rustc, simply because it allows to easily switch compilers between several versions of both stable and nightly. It also allows you to download the respective stdlib crate, giving you the option of an offline reference. diff --git a/INSTALL.md b/INSTALL.md index 6a282aa..c867d2f 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,10 +1,10 @@ # Installation Currently there are no distribution packages available. -However installation is reasonably straight-forward, since Diflouroborane compiles into a single +However installation is reasonably straight-forward, since Difluoroborane compiles into a single mostly static binary with few dependencies. -At the moment only Linux is supported. If you managed to compile Diflouroborane please open an issue +At the moment only Linux is supported. If you managed to compile Difluoroborane please open an issue outlining your steps or add a merge request expanding this part. Thanks! ## Requirements @@ -12,7 +12,7 @@ outlining your steps or add a merge request expanding this part. Thanks! General requirements; scroll down for distribution-specific instructions - GNU SASL (libgsasl). - * If you want to compile Diflouroborane from source you will potentially also need development + * If you want to compile Difluoroborane from source you will potentially also need development headers - capnproto - rustc stable / nightly >= 1.48 @@ -26,7 +26,7 @@ $ pacman -S gsasl rust capnproto ## Compiling from source -Diflouroborane uses Cargo, so compilation boils down to: +Difluoroborane uses Cargo, so compilation boils down to: ```shell $ cargo build --release diff --git a/README.md b/README.md index 3ea7ad9..c9e1ebf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# FabAccess Diflouroborane +# FabAccess Difluoroborane -Diflouroborane (shorter: BFFH, the chemical formula for Diflouroborane) is the server part of +Difluoroborane (shorter: BFFH, the chemical formula for Difluoroborane) is the server part of FabAccess. It provides a server-side implementation of the [FabAccess API](https://gitlab.com/fabinfra/fabaccess/fabaccess-api). diff --git a/bffhd/lib.rs b/bffhd/lib.rs index f7fe6f7..6ce37b1 100644 --- a/bffhd/lib.rs +++ b/bffhd/lib.rs @@ -3,7 +3,7 @@ //#![warn(missing_docs)] //#![warn(missing_crate_level_docs)] -//! Diflouroborane +//! Difluoroborane //! //! This is the capnp component of the FabAccess project. //! The entry point of bffhd can be found in [bin/bffhd/main.rs](../bin/bffhd/main.rs) @@ -67,7 +67,7 @@ use lightproc::recoverable_handle::RecoverableHandle; use signal_hook::consts::signal::*; use tracing::Span; -pub struct Diflouroborane { +pub struct Difluoroborane { config: Config, executor: Executor<'static>, pub statedb: StateDB, @@ -135,7 +135,7 @@ pub enum BFFHError { ), } -impl Diflouroborane { +impl Difluoroborane { pub fn setup() {} pub fn new(config: Config) -> Result { diff --git a/bin/bffhd/main.rs b/bin/bffhd/main.rs index fff25b7..727a1a8 100644 --- a/bin/bffhd/main.rs +++ b/bin/bffhd/main.rs @@ -1,5 +1,5 @@ use clap::{Arg, Command, ValueHint}; -use diflouroborane::{config, Diflouroborane}; +use difluoroborane::{config, Difluoroborane}; use std::str::FromStr; use std::{env, io, io::Write, path::PathBuf}; @@ -15,12 +15,12 @@ fn main() -> miette::Result<()> { FabAccess {apiver}\n\ \t[{build_kind} build built on {build_time}]\n\ \t {rustc_version}\n\t {cargo_version}", - version=diflouroborane::env::PKG_VERSION, + version=difluoroborane::env::PKG_VERSION, apiver="0.3", - rustc_version=diflouroborane::env::RUST_VERSION, - cargo_version=diflouroborane::env::CARGO_VERSION, - build_time=diflouroborane::env::BUILD_TIME_3339, - build_kind=diflouroborane::env::BUILD_RUST_CHANNEL)) + rustc_version=difluoroborane::env::RUST_VERSION, + cargo_version=difluoroborane::env::CARGO_VERSION, + build_time=difluoroborane::env::BUILD_TIME_3339, + build_kind=difluoroborane::env::BUILD_RUST_CHANNEL)) .about(clap::crate_description!()) .arg(Arg::new("config") .help("Path to the config file to use") @@ -98,7 +98,7 @@ fn main() -> miette::Result<()> { let configpath = matches .value_of("config") - .unwrap_or("/etc/diflouroborane.dhall"); + .unwrap_or("/etc/difluoroborane.dhall"); // Check for the --print-default option first because we don't need to do anything else in that // case. @@ -140,7 +140,7 @@ fn main() -> miette::Result<()> { if matches.is_present("dump") { return Err(miette::miette!("DB Dumping is currently not implemented, except for the users db, using `--dump-users`")); } else if matches.is_present("dump-users") { - let bffh = Diflouroborane::new(config)?; + let bffh = Difluoroborane::new(config)?; let number = bffh.users.dump_file( matches.value_of("dump-users").unwrap(), @@ -151,7 +151,7 @@ fn main() -> miette::Result<()> { return Ok(()); } else if matches.is_present("load") { - let bffh = Diflouroborane::new(config)?; + let bffh = Difluoroborane::new(config)?; bffh.users.load_file(matches.value_of("load").unwrap())?; @@ -179,7 +179,7 @@ fn main() -> miette::Result<()> { } config.logging.format = matches.value_of("log format").unwrap_or("full").to_string(); - let mut bffh = Diflouroborane::new(config)?; + let mut bffh = Difluoroborane::new(config)?; bffh.run()?; }