From 99be8844c7c4759e6aed56aca503219be7049fef Mon Sep 17 00:00:00 2001
From: Dietmar Maurer <dietmar@proxmox.com>
Date: Sat, 16 Feb 2019 12:28:50 +0100
Subject: [PATCH] buildcfg.rs: improve doc

---
 src/buildcfg.rs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/buildcfg.rs b/src/buildcfg.rs
index f0d24b8e..83ee0605 100644
--- a/src/buildcfg.rs
+++ b/src/buildcfg.rs
@@ -1,5 +1,16 @@
+//! Exports configuration data from the build system
+
+/// The configured configuration directory
 pub const CONFIGDIR: &'static str = env!("PROXMOX_CONFIGDIR");
 
+/// Prepend configuration directory to a file name
+///
+/// This is a simply way to get the full path for configuration files.
+/// #### Example:
+/// ```
+/// # #[macro_use] extern crate proxmox_backup;
+/// let cert_path = configdir!("/proxy.pfx");
+/// ```
 #[macro_export]
 macro_rules! configdir {
     ($subdir:expr) => (concat!(env!("PROXMOX_CONFIGDIR"), $subdir))