diff options
author | Emanuele Di Pascale <emanuele@voltanet.io> | 2018-07-19 18:28:25 +0200 |
---|---|---|
committer | Emanuele Di Pascale <emanuele@voltanet.io> | 2018-07-19 18:28:25 +0200 |
commit | 9e2f406adbb18c320e10689abae3a0f33da9634b (patch) | |
tree | baea5db1454ec16bb2f7eb3c390e881583e6881e /doc | |
parent | Merge pull request #2678 from pguibert6WIND/sanity_netns (diff) | |
download | frr-9e2f406adbb18c320e10689abae3a0f33da9634b.tar.xz frr-9e2f406adbb18c320e10689abae3a0f33da9634b.zip |
doc: add cmd line param section to modules.rst
Signed-off-by: Emanuele Di Pascale <emanuele@voltanet.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/developer/modules.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/developer/modules.rst b/doc/developer/modules.rst index b832413a6..bde7682e4 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 ----- |