priv_sep

commit 1e3eb6577abd9e7ae9b56242ced252fb81e97430
parent 197eb59641724d10bfdc4a3dc0227195b1e18764
Author: Zack Newman <zack@philomathiclife.com>
Date:   Mon, 28 Aug 2023 17:58:16 -0600

small fixes in documentation

Diffstat:
M
Cargo.toml
 | 
4
++--
M
README.md
 | 
4
++--
M
src/lib.rs
 | 
5
+++--

3 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,14 +2,14 @@
 authors = ["Zack Newman <zack@philomathiclife.com>"]
 categories = ["development-tools::ffi", "external-ffi-bindings", "os"]
 description = "FFI for pledge(2) and unveil(2) on OpenBSD."
-documentation = "https://docs.rs/priv_sep"
+documentation = "https://docs.rs/priv_sep/latest/priv_sep/"
 edition = "2021"
 keywords = ["ffi", "openbsd", "privsep", "security"]
 license = "MIT OR Apache-2.0"
 name = "priv_sep"
 readme = "README.md"
 repository = "https://git.philomathiclife.com/repos/priv_sep/"
-version = "0.4.0"
+version = "0.4.1"
 
 [lib]
 name = "priv_sep"
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
   
 [`priv_sep`](https://docs.rs/priv_sep/latest/priv_sep) is a library for privilege separation.
 It is currently designed around [`pledge(2)`](https://man.openbsd.org/amd64/pledge.2) and
-[`unveil(2)`](https://man.openbsd.org/amd64/unveil.2) for OpenBSD-stable—that is correct, `stable` not `current`—
+[`unveil(2)`](https://man.openbsd.org/amd64/unveil.2) for OpenBSD-stable—that is correct, -stable not -current—
 but in the future may contain functionality for Linux's
 [`seccomp(2)`](https://man7.org/linux/man-pages/man2/seccomp.2.html).  
   
@@ -27,7 +27,7 @@ are ignored, so it is not an error to pass in duplicate values for their corresp
   
 This package will be actively maintained to stay in-sync with the latest version of OpenBSD-stable; as a result,
 the crate is only tested on the `x86_64-unknown-openbsd` target. While OpenBSD supports both the most recent
-`release/stable` release as well as the previous version, only the most recent version will be supported by this
+-release/-stable release as well as the previous version, only the most recent version will be supported by this
 library. For that reason any removal of `promises` in subsequent releases of `pledge(2)` will lead to breaking
 changes in this library as the corresponding `Promise` variant will be removed.  
   
diff --git a/src/lib.rs b/src/lib.rs
@@ -2,7 +2,7 @@
 //!  
 //! `priv_sep` is a library for privilege separation.
 //! It is currently designed around [`pledge(2)`](https://man.openbsd.org/amd64/pledge.2) and
-//! [`unveil(2)`](https://man.openbsd.org/amd64/unveil.2) for OpenBSD-stable—that is correct, `stable` not `current`—
+//! [`unveil(2)`](https://man.openbsd.org/amd64/unveil.2) for OpenBSD-stable—that is correct, -stable not -current—
 //! but in the future may contain functionality for Linux's
 //! [`seccomp(2)`](https://man7.org/linux/man-pages/man2/seccomp.2.html).  
 //!  
@@ -42,6 +42,7 @@
     clippy::blanket_clippy_restriction_lints,
     clippy::implicit_return,
     clippy::missing_trait_methods,
+    clippy::min_ident_chars,
     clippy::unseparated_literal_suffix
 )]
 #![cfg(feature = "openbsd")]
@@ -267,7 +268,7 @@ impl std::error::Error for UnveilErr {}
 /// This is a private function and uses `Option` for the path to indicate calling `unveil(2)` with
 /// two `NULL` arguments.
 #[inline]
-#[allow(unsafe_code, clippy::indexing_slicing, clippy::into_iter_on_ref)]
+#[allow(unsafe_code, clippy::indexing_slicing)]
 fn unveil<P: AsRef<Path>, const N: usize>(
     path: Option<P>,
     permissions: [Permission; N],