From: Emanuele Di Pascale Date: Thu, 19 Jul 2018 16:28:25 +0000 (+0200) Subject: doc: add cmd line param section to modules.rst X-Git-Tag: frr-6.1-dev~158^2 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=9e2f406adbb18c320e10689abae3a0f33da9634b;p=mirror%2Ffrr.git doc: add cmd line param section to modules.rst Signed-off-by: Emanuele Di Pascale --- diff --git a/doc/developer/modules.rst b/doc/developer/modules.rst index b832413a6c..bde7682e4e 100644 --- a/doc/developer/modules.rst +++ b/doc/developer/modules.rst @@ -100,6 +100,15 @@ a function that removes all of a module's installed hooks. There's also the ``frr_module`` symbol in modules, pretty much a standard entry point for loadable modules. +Command line parameters +----------------------- + +Command line parameters can be passed directly to a module by appending a +colon to the module name when loading it, e.g. ``-M mymodule:myparameter``. +The text after the colon will be accessible in the module's code through +``THIS_MODULE->load_args``. For example, see how the format parameter is +configured in the ``zfpm_init()`` function inside ``zebra_fpm.c``. + Hooks -----