diff libpam-sys/README.md @ 160:09dff285ff5e

Switch default PAM detection strategy to target-based. To make cross-compilation easier (like for docs.rs), this change makes OS-based detection of PAM the default, only falling back to probing the actual installed PAM as a last resort. I haven't been able to find a Linux distribution that uses anything but Linux-PAM.
author Paul Fisher <paul@pfish.zone>
date Sun, 13 Jul 2025 15:38:00 -0400
parents d5b7b28d754e
children e9354e655f38
line wrap: on
line diff
--- a/libpam-sys/README.md	Sat Jul 12 18:16:18 2025 -0400
+++ b/libpam-sys/README.md	Sun Jul 13 15:38:00 2025 -0400
@@ -3,17 +3,17 @@
 This crate provides low-level access to PAM, working with multiple PAM implementations.
 You do not need PAM system headers installed to use this!
 
-If you're looking for a nice, safe, Rusty API to PAM, may I recommend [nonstick][nonstick]?
+If you're looking for a nice, safe, Rusty API to PAM, may I recommend [nonstick]?
 
 ## PAM implementations
 
-This crate detects the PAM implementation you have installed, or guesses based on the OS if that's unavailable.
 Supported PAM implementations are defined in the `pam_impl::PamImpl` enum.
 
+This crate automatically chooses the appropriate PAM implementation you are most likely to need installed based on the target OS.
 You can also explicitly specify the PAM implementation you want (if not detected correctly) by setting the `LIBPAMSYS_IMPL` environment variable **at build time**.
 All build-time configuration is performed by the build script of the [`libpam-sys-consts` crate](https://crates.io/crates/libpam-sys-consts).
 
-Each implementation exports all the functionality available in its respective PAM library.
+Normally, this crate exports all functionality available in the selected PAM library.
 `XSso` exports only the subset of the [X/SSO specification][xsso] supported by both OpenPAM and Sun PAM.
 
 ## Testing