aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJon Masters <jcm@jonmasters.org>2010-03-04 03:07:05 -0500
committerJon Masters <jcm@jonmasters.org>2010-03-04 03:07:05 -0500
commitf57f3f6c46ff6198821c4ddc1d07a9dd382af721 (patch)
treedd20303189069051869f935493693b1436e4e6f5
parentea2b03bd564e01f2a51091a4302933a3e7589e44 (diff)
downloadmodule-init-tools-f57f3f6c46ff6198821c4ddc1d07a9dd382af721.tar.gz
config_filter: add some documentation
Signed-off-by: Jon Masters <jcm@jonmasters.org>
-rw-r--r--config_filter.c8
-rw-r--r--config_filter.h7
2 files changed, 15 insertions, 0 deletions
diff --git a/config_filter.c b/config_filter.c
index 7d5bbe5..cf3c3df 100644
--- a/config_filter.c
+++ b/config_filter.c
@@ -1,3 +1,11 @@
+/* config_filter.c: handle hidden or non-configuration files in config dirs.
+
+ These functions are called whenever we will parse configuration files to
+ ensure we are not picking up backups, SCM meta data, package artifacts.
+ Eventually all config files will have to follow a convention so these
+ lists of possible exceptions should not have to grow by very much.
+*/
+
#include <string.h>
#include "util.h"
diff --git a/config_filter.h b/config_filter.h
index ba9aaed..38dc957 100644
--- a/config_filter.h
+++ b/config_filter.h
@@ -1,3 +1,10 @@
+/* config_filter.h: handle hidden or non-configuration files in config dirs.
+
+ These functions are called whenever we will parse configuration files to
+ ensure we are not picking up backups, SCM meta data, package artifacts.
+ Eventually all config files will have to follow a convention so these
+ lists of possible exceptions should not have to grow by very much.
+*/
#ifndef _MODINITTOOLS_CONFIG_FILTER_H
#define _MODINITTOOLS_CONFIG_FILTER_H