summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Turner <jturner.usa@gmail.com>2025-12-11 02:42:09 +0000
committerJohn Turner <jturner.usa@gmail.com>2025-12-14 01:37:49 +0000
commit84cc87e6e4b131e2f3f3fca327129d998f7f6b9f (patch)
treeaacfa0b49758c919390952bbc62bdff644c4ebf6
parent467ffd051aed0c7dd9e717367900d34ba0c5586a (diff)
downloadgentoo-utils-84cc87e6e4b131e2f3f3fca327129d998f7f6b9f.tar.gz
add docs to profile module
-rw-r--r--src/repo/profile/mod.rs13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/repo/profile/mod.rs b/src/repo/profile/mod.rs
index 4736444..31861b9 100644
--- a/src/repo/profile/mod.rs
+++ b/src/repo/profile/mod.rs
@@ -1,3 +1,16 @@
+//! Evaluate profiles:
+//! ```rust
+//! use gentoo_utils::repo::Repo;
+//!
+//! let repo = Repo::new("/var/db/repos/gentoo");
+//! let profile = repo.evaluate_profile("default/linux/23.0")
+//! .expect("failed to evaluate profile");
+//!
+//! for (key, value) in profile.make_defaults() {
+//! println!("{key} = {value}");
+//! }
+//! ```
+
use std::{
collections::HashMap,
fs::{self, File},