changeset 191:e915c54097d6

Clean up docs and link versions to the right place.
author Paul Fisher <paul@pfish.zone>
date Sat, 02 Aug 2025 19:01:21 -0400
parents 995aca290452
children 4c39eaa4a5ae
files Cargo.lock Cargo.toml libpam-sys/Cargo.lock libpam-sys/Cargo.toml libpam-sys/build.rs libpam-sys/libpam-sys-helpers/Cargo.toml libpam-sys/src/lib.rs src/lib.rs src/libpam/handle.rs
diffstat 9 files changed, 35 insertions(+), 28 deletions(-) [+]
line wrap: on
line diff
--- a/Cargo.lock	Sat Aug 02 18:47:46 2025 -0400
+++ b/Cargo.lock	Sat Aug 02 19:01:21 2025 -0400
@@ -16,7 +16,7 @@
 
 [[package]]
 name = "libpam-sys"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "libc",
  "libpam-sys-helpers",
@@ -25,14 +25,14 @@
 
 [[package]]
 name = "libpam-sys-helpers"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "libpam-sys-impls",
 ]
 
 [[package]]
 name = "libpam-sys-impls"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "libc",
 ]
--- a/Cargo.toml	Sat Aug 02 18:47:46 2025 -0400
+++ b/Cargo.toml	Sat Aug 02 19:01:21 2025 -0400
@@ -51,9 +51,9 @@
 [dependencies]
 bitflags = "2.9.0"
 libc = { optional = true, version = "0.2" }
-libpam-sys = { optional = true, version = "0.1.0", path = "libpam-sys" }
-libpam-sys-helpers = { optional = true, version = "0.1.0", path = "libpam-sys/libpam-sys-helpers" }
-libpam-sys-impls = { version = "0.1.0", path = "libpam-sys/libpam-sys-impls" }
+libpam-sys = { optional = true, version = "0.1.1", path = "libpam-sys" }
+libpam-sys-helpers = { optional = true, version = "0.1.1", path = "libpam-sys/libpam-sys-helpers" }
+libpam-sys-impls = { version = "0.1.1", path = "libpam-sys/libpam-sys-impls" }
 
 [build-dependencies]
-libpam-sys-impls = { version = "0.1.0", path = "libpam-sys/libpam-sys-impls" }
+libpam-sys-impls = { version = "0.1.1", path = "libpam-sys/libpam-sys-impls" }
--- a/libpam-sys/Cargo.lock	Sat Aug 02 18:47:46 2025 -0400
+++ b/libpam-sys/Cargo.lock	Sat Aug 02 19:01:21 2025 -0400
@@ -216,7 +216,7 @@
 
 [[package]]
 name = "libpam-sys"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "libc",
  "libpam-sys-helpers",
@@ -225,21 +225,21 @@
 
 [[package]]
 name = "libpam-sys-helpers"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "libpam-sys-impls",
 ]
 
 [[package]]
 name = "libpam-sys-impls"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "libc",
 ]
 
 [[package]]
 name = "libpam-sys-test"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "bindgen",
  "ctest",
--- a/libpam-sys/Cargo.toml	Sat Aug 02 18:47:46 2025 -0400
+++ b/libpam-sys/Cargo.toml	Sat Aug 02 19:01:21 2025 -0400
@@ -3,7 +3,7 @@
 members = ["libpam-sys-impls", "libpam-sys-helpers", "libpam-sys-test"]
 
 [workspace.package]
-version = "0.1.0"
+version = "0.1.1"
 authors = ["Paul Fisher <paul@pfish.zone>"]
 repository = "https://hg.pfish.zone/crates/nonstick/"
 edition = "2021"
@@ -32,10 +32,10 @@
 
 [dependencies]
 libc = "0.2"
-libpam-sys-impls = { version = "0.1.0", path = "libpam-sys-impls" }
+libpam-sys-impls = { version = "0.1.1", path = "libpam-sys-impls" }
 
 [target.'cfg(doc)'.dependencies]
-libpam-sys-helpers = { version = "0.1.0", path = "libpam-sys-helpers" }
+libpam-sys-helpers = { version = "0.1.1", path = "libpam-sys-helpers" }
 
 [build-dependencies]
-libpam-sys-impls = { version = "0.1.0", path = "libpam-sys-impls" }
+libpam-sys-impls = { version = "0.1.1", path = "libpam-sys-impls" }
--- a/libpam-sys/build.rs	Sat Aug 02 18:47:46 2025 -0400
+++ b/libpam-sys/build.rs	Sat Aug 02 19:01:21 2025 -0400
@@ -5,12 +5,15 @@
     libpam_sys_impls::enable_pam_impl_cfg();
 
     let pam_impl = libpam_sys_impls::build_target_impl();
-    let impl_str = pam_impl.map(|i| format!("{i:?}")).unwrap_or("[undefined]".into());
+    let impl_str = pam_impl
+        .map(|i| format!("{i:?}"))
+        .unwrap_or("[undefined]".into());
     println!("cargo:rustc-env=LIBPAMSYS_IMPL={impl_str}");
     let output = match pam_impl {
         None => "".into(),
         Some(pam_impl) => {
-            format!("\
+            format!(
+                "\
                 /// The implementation of PAM this library was built against.
                 pub const CURRENT: PamImpl = PamImpl::{pam_impl:?};
                 /// The name of the PAM implementation this library was built
@@ -18,9 +21,13 @@
                 #[macro_export]
                 macro_rules! pam_impl_name {{ () => {{ \"{pam_impl:?}\" }} }}
                 pub(crate) use pam_impl_name;
-            ")
+                "
+            )
         }
     };
-    let outfile = format!("{out}/pam_impl_consts.rs", out = env::var("OUT_DIR").expect("missing OUT_DIR env var"));
+    let outfile = format!(
+        "{out}/pam_impl_consts.rs",
+        out = env::var("OUT_DIR").expect("missing OUT_DIR env var")
+    );
     fs::write(outfile, output).expect("couldn't write output file");
 }
--- a/libpam-sys/libpam-sys-helpers/Cargo.toml	Sat Aug 02 18:47:46 2025 -0400
+++ b/libpam-sys/libpam-sys-helpers/Cargo.toml	Sat Aug 02 19:01:21 2025 -0400
@@ -10,4 +10,4 @@
 readme = "README.md"
 
 [build-dependencies]
-libpam-sys-impls = { version = "0.1.0", path = "../libpam-sys-impls" }
\ No newline at end of file
+libpam-sys-impls = { version = "0.1.1", path = "../libpam-sys-impls" }
\ No newline at end of file
--- a/libpam-sys/src/lib.rs	Sat Aug 02 18:47:46 2025 -0400
+++ b/libpam-sys/src/lib.rs	Sat Aug 02 19:01:21 2025 -0400
@@ -28,7 +28,7 @@
 /// that is being built for).
 pub mod pam_impl {
     #[doc(inline)]
-    pub use libpam_sys_impls::{PamImpl, enable_pam_impl_cfg, pam_impl_cfg_string};
+    pub use libpam_sys_impls::{enable_pam_impl_cfg, pam_impl_cfg_string, PamImpl};
 
     include!(concat!(env!("OUT_DIR"), "/pam_impl_consts.rs"));
 }
--- a/src/lib.rs	Sat Aug 02 18:47:46 2025 -0400
+++ b/src/lib.rs	Sat Aug 02 19:01:21 2025 -0400
@@ -186,17 +186,18 @@
 //!   - [Application Developers' Guide][adg]
 //!   - [Module Writers' Guide][mwg]
 //!   - [System Administrators' Guide][sag]
-//! - PAM framework man page for developers:
+//! - PAM framework man pages for developers:
 //!   - [Linux-PAM developer man page][man7]
 //!   - [OpenPAM developer man page][manbsd]
 //!   - [Illumos PAM developer man page][mansun]
-//! - PAM framework man page for system administrators:
+//! - PAM framework man pages for system administrators:
 //!   - [Linux-PAM admin documentation][man7pam8]
 //!   - [OpenPAM admin documentation][bsdpam8]
 //!   - [Illumos pam.conf documentation][sunpam5]
 //! - [The original PAM specification][spec] (mostly of historical interest)
-//! - [Cooking spray](https://en.wikipedia.org/wiki/Cooking_spray)
-#![doc = ""]
+//! - [Wikipedia: Cooking spray][spray]
+//!
+//! [spray]: https://en.wikipedia.org/wiki/Cooking_spray
 #![doc = _doc::man7!(man7pam8: 8 pam)]
 #![doc = _doc::manbsd!(bsdpam8: 8 pam)]
 #![doc = _doc::mansun!(sunpam5: 5 "pam.conf")]
--- a/src/libpam/handle.rs	Sat Aug 02 18:47:46 2025 -0400
+++ b/src/libpam/handle.rs	Sat Aug 02 19:01:21 2025 -0400
@@ -281,11 +281,10 @@
     )]
     #[cfg_attr(
         pam_impl = "LinuxPam",
-        doc = "Ends the transaction \"quietly\", reporting `error_code` to cleanup callbacks."
+        doc = "Ends the transaction \"quietly\", reporting the given result."
     )]
     ///
-    /// On Linux-PAM only, this sets the
-    /// [`PAM_DATA_SILENT`](libpam_sys::PAM_DATA_SILENT) flag on the flags
+    /// On Linux-PAM only, this sets the `PAM_DATA_SILENT` flag on the value
     /// passed to the cleanup callbacks. This conventionally means that this
     /// `pam_end` call is occurring on a forked process, and that a session
     /// may still be open on the parent process, and modules "should not treat