diff libpam-sys/libpam-sys-helpers/README.md @ 148:4b3a5095f68c

Move libpam-sys helpers into their own library. - Renames libpam-sys-helpers to libpam-sys-consts. - Moves libpam-sys-helpers::helpers into libpam-sys-helpers, which moves them completely out of libpam-sys's dependency chain. - Moves the aliases from libpam-sys into libpam-sys::aliases.
author Paul Fisher <paul@pfish.zone>
date Mon, 07 Jul 2025 12:11:43 -0400
parents efbc235f01d3
children
line wrap: on
line diff
--- a/libpam-sys/libpam-sys-helpers/README.md	Sun Jul 06 19:23:02 2025 -0400
+++ b/libpam-sys/libpam-sys-helpers/README.md	Mon Jul 07 12:11:43 2025 -0400
@@ -1,57 +1,5 @@
-# `libpam-sys-helpers`: cross-platform tools for libpam
-
-This crate contains tools for `libpam` that **don't directly link to `libpam.so`**.
-This allows for creation of `libpam` abstractions (e.g. test doubles) that don't require libpam to be present if they don't link directly into it.
-
-## Handling PAM implementations
-
-Different PAM implementations have different constants and some different behaviors.
-If you need to change your behavior based on PAM implementation, there are a few ways to do so.
-
-### Constants
-
-The current PAM implementation is available in `PamImpl::CURRENT`.
-This is present as a string literal macro in `pam_impl_name!`.
-
-### Conditional compilation
-
-This package provides custom `#[cfg]`s to compile based on the current PAM implementation.
-
-First, **enable custom `#[cfg]`s in your build.rs**:
-
-```rust
-// build.rs
-use libpam_sys_helpers::pam_impl;
+# `libpam-sys-helpers`: Cross-platform helpers for `libpam-sys`
 
-fn main() {
-    pam_impl::enable_pam_impl_cfg();
-    
-    // everything else you do at build time
-}
-```
-
-This will then allow you to use the `pam_impl` configuration variable at compile time:
-
-```rust
-#[cfg(pam_impl = "LinuxPam")]
-fn handle_pam() {
-    // do things in a Linux-PAM specific way
-}
+This provides memory-management helpers for `libpam-sys`.
 
-#[cfg(not(pam_impl = "LinuxPam"))]
-fn handle_pam() {
-    // do things in another way
-}
-```
-
-## Configuration
-
-By default, this crate automatically detects your libpam version.
-Known implementations are listed in the `PamImpl` enum.
-
-You can override this **at build time** by setting the `LIBPAMSYS_IMPL` environment variable to one of those names.
-For example, `LIBPAMSYS_IMPL=OpenPam cargo build` will build this library for OpenPAM.
-
-## MSRV
-
-This library supports **Rust 1.75**, as the version currently (July 2025) available in Debian Trixie and Ubuntu 24.04 LTS.
\ No newline at end of file
+This does not actually depend upon `libpam-sys`; it only uses `libpam-sys-consts`.
\ No newline at end of file