document config_foreach, close #2162
authorFelix Fietkau <nbd@openwrt.org>
Sat, 4 Aug 2007 12:23:46 +0000 (12:23 +0000)
committerFelix Fietkau <nbd@openwrt.org>
Sat, 4 Aug 2007 12:23:46 +0000 (12:23 +0000)
SVN-Revision: 8342

docs/config.tex

index d13297c..17417c9 100644 (file)
@@ -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.
+