Skip to content

Commit

Permalink
stores: add environment variable doc for stores
Browse files Browse the repository at this point in the history
  • Loading branch information
nerdroychan committed Jul 29, 2024
1 parent 9fdba59 commit 1fce017
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/stores.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@
//! constructor of the store's constructor function. For available options other than `name`, one
//! can refer to the module-level documentation of a specific store.
//!
//! Similar to the `[global]` secition of a benchmark, the options in a `[map]` section can also
//! be overwritten via environment variables.
//! For example, if the user needs to override `x` in `[map]`, setting the environment variable
//! `map.x` will get the job done.
//!
//! ## Registering New Stores
//!
//! When users would like to dynamically register new key-value stores from their own crate, first
Expand Down

0 comments on commit 1fce017

Please sign in to comment.