summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornbd <nbd@3c298f89-4303-0410-b956-a3cf2f4a3e73>2007-08-04 12:23:46 +0000
committernbd <nbd@3c298f89-4303-0410-b956-a3cf2f4a3e73>2007-08-04 12:23:46 +0000
commitdd622e2557fa084e4d992e9b7da1315910a45136 (patch)
tree8263cc5141da6473b8f7bce723bbf131ddfce249
parentd1d50072edabfcb188caad33f570b20e8837f4a4 (diff)
document config_foreach, close #2162
git-svn-id: svn://svn.openwrt.org/openwrt/trunk@8342 3c298f89-4303-0410-b956-a3cf2f4a3e73
-rw-r--r--docs/config.tex19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/config.tex b/docs/config.tex
index d13297c4f..17417c99a 100644
--- a/docs/config.tex
+++ b/docs/config.tex
@@ -57,6 +57,19 @@ after \texttt{config\_load} is done.
That allows you to process sections both before and after all options were
processed.
+Another way of iterating on config sections is using the \texttt{config\_foreach} command.
+
+Syntax:
+\begin{Verbatim}
+config_foreach <function name> [<sectiontype>] [<arguments...>]
+\end{Verbatim}
+
+This command will run the supplied function for every single config section in the currently
+loaded config. The section name will be passed to the function as argument 1.
+If the section type is added to the command line, the function will only be called for
+sections of the given type.
+
+
You can access already processed options with the \texttt{config\_get} command
Syntax:
@@ -80,3 +93,9 @@ Syntax:
config_set <section> <option> <value>
\end{Verbatim}
+If a config section is unnamed, an automatically generated name will
+be assigned internally, e.g. \texttt{cfg1}, \texttt{cfg2}, ...
+
+While it is possible, using unnamed sections through these autogenerated names is
+strongly discouraged. Use callbacks or \texttt{config\_foreach} instead.
+