Skip to content

Use SYSTEMD_CONVENTIONAL_BASES in the doc example #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cgwalters wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Use SYSTEMD_CONVENTIONAL_BASES in the doc example #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,11 @@
//! # use liboverdrop;
//! // Scan for fragments under:
//! // * /usr/lib/my-crate/config.d/*.toml
//! // * /run/my-crate/config.d/*.toml
//! // * /usr/local/lib/my-crate/config.d/*.toml
//! // * /etc/my-crate/config.d/*.toml
//! // * /run/my-crate/config.d/*.toml
//!
//! let base_dirs = [
//! "/usr/lib",
//! "/run",
//! "/etc",
//! ];
//! let fragments = liboverdrop::scan(&base_dirs, "my-crate/config.d", &["toml"], false);
//! let fragments = liboverdrop::scan(liboverdrop::SYSTEMD_CONVENTIONAL_BASES, "my-crate/config.d", &["toml"], false);
//!
//! for (filename, filepath) in fragments {
//! println!("fragment '{}' located at '{}'", filename.to_string_lossy(), filepath.display());
Expand Down Expand Up @@ -93,6 +89,7 @@ pub const SYSTEMD_CONVENTIONAL_BASES: &[&str] = &["/usr/lib", "/usr/local/lib",
/// # Arguments
///
/// * `base_dirs` - Base components of directories where configuration fragments are located.
/// System services will usually want [`SYSTEMD_CONVENTIONAL_BASES`] here.
/// * `shared_path` - Common relative path from each entry in `base_dirs` to the directory
/// holding configuration fragments.
/// * `allowed_extensions` - Only scan files that have an extension listed in `allowed_extensions`.
Expand Down