qi-hardware/openwrt-xburst
1
0
Fork 0
mirror of git://projects.qi-hardware.com/openwrt-xburst.git synced 2024-11-23 23:46:16 +02:00
Code

document config_foreach, close #2162

Browse Source 
git-svn-id: svn://svn.openwrt.org/openwrt/trunk@8342 3c298f89-4303-0410-b956-a3cf2f4a3e73
This commit is contained in:
nbd 2007-08-04 12:23:46 +00:00
parent d1d50072ed
commit dd622e2557
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/config.tex
View 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.