comparison libpam-sys/README.md @ 158:d5b7b28d754e

Add `__TARGET_DEFAULT__` PamImpl and set up for docsrs build. Also fixes some formatting stuff.
author Paul Fisher <paul@pfish.zone>
date Sat, 12 Jul 2025 17:17:37 -0400
parents 4b3a5095f68c
children 09dff285ff5e
comparison
equal deleted inserted replaced
157:0099f2f79f86 158:d5b7b28d754e
12 12
13 You can also explicitly specify the PAM implementation you want (if not detected correctly) by setting the `LIBPAMSYS_IMPL` environment variable **at build time**. 13 You can also explicitly specify the PAM implementation you want (if not detected correctly) by setting the `LIBPAMSYS_IMPL` environment variable **at build time**.
14 All build-time configuration is performed by the build script of the [`libpam-sys-consts` crate](https://crates.io/crates/libpam-sys-consts). 14 All build-time configuration is performed by the build script of the [`libpam-sys-consts` crate](https://crates.io/crates/libpam-sys-consts).
15 15
16 Each implementation exports all the functionality available in its respective PAM library. 16 Each implementation exports all the functionality available in its respective PAM library.
17 `XSso` exports only what is in the [X/SSO specification][xsso]. 17 `XSso` exports only the subset of the [X/SSO specification][xsso] supported by both OpenPAM and Sun PAM.
18 18
19 ## Testing 19 ## Testing
20 20
21 Tests are mostly run through `libpam-sys-test`, which lives in the crate's workspace in its repository (along with [nonstick]). 21 Tests are mostly run through `libpam-sys-test`, which lives in the crate's workspace in its repository (along with [nonstick]).
22 22
23 - [`ctest`][ctest] verifies the correctness of the FFI bindings (function/struct alignment, etc.). 23 - [`ctest`][ctest] verifies the correctness of the FFI bindings (function/struct alignment, etc.).
24 - A kind of scuffed homebrew thing also verifies that the constants are correct. 24 - A kind of scuffed homebrew thing also verifies that the constants are correct.
25 25
26 Testing is mainly accomplished through the `libpam-sys-test` package in this crate's workspace.
27 There are some unit tests of glue code and other type checks. 26 There are some unit tests of glue code and other type checks.
28 27
29 ## Minimum Rust version 28 ## Minimum Rust version
30 29
31 This crate supports **Rust 1.75**, the current version in Debian Trixie and Ubuntu 24.04.2 LTS. 30 This crate supports **Rust 1.75**, the current version in Debian Trixie and Ubuntu 24.04.2 LTS.