proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-08 07:37:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #5826 from mjstapp/fix_cli_pfx_doc

Browse Source 
doc: correct ip prefix token mapping table
This commit is contained in:
Donald Sharp 2020-02-19 15:08:08 -05:00 committed by GitHub
commit 67c5e28cb9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/developer/cli.rst
View File

@ -371,11 +371,11 @@ Type rules
+----------------------------+--------------------------------+--------------------------+ +----------------------------+--------------------------------+--------------------------+
| ``A.B.C.D + X:X::X:X`` | ``const union sockunion *`` | ``NULL`` | | ``A.B.C.D + X:X::X:X`` | ``const union sockunion *`` | ``NULL`` |
+----------------------------+--------------------------------+--------------------------+ +----------------------------+--------------------------------+--------------------------+
| ``A.B.C.D/M`` | ``const struct prefix_ipv4 *`` | ``NULL`` | | ``A.B.C.D/M`` | ``const struct prefix_ipv4 *`` | ``all-zeroes struct`` |
+----------------------------+--------------------------------+--------------------------+ +----------------------------+--------------------------------+--------------------------+
| ``X:X::X:X/M`` | ``const struct prefix_ipv6 *`` | ``NULL`` | | ``X:X::X:X/M`` | ``const struct prefix_ipv6 *`` | ``all-zeroes struct`` |
+----------------------------+--------------------------------+--------------------------+ +----------------------------+--------------------------------+--------------------------+
| ``A.B.C.D/M + X:X::X:X/M`` | ``const struct prefix *`` | ``NULL`` | | ``A.B.C.D/M + X:X::X:X/M`` | ``const struct prefix *`` | ``all-zeroes struct`` |
+----------------------------+--------------------------------+--------------------------+ +----------------------------+--------------------------------+--------------------------+
| ``(0-9)`` | ``long`` | ``0`` | | ``(0-9)`` | ``long`` | ``0`` |
+----------------------------+--------------------------------+--------------------------+ +----------------------------+--------------------------------+--------------------------+
@ -395,8 +395,10 @@ Note the following details:
``word`` tokens (e.g. constant words). This is useful if some parts of a ``word`` tokens (e.g. constant words). This is useful if some parts of a
command are optional. The type will be ``const char *``. command are optional. The type will be ``const char *``.
- ``[no]`` will be passed as ``const char *no``. - ``[no]`` will be passed as ``const char *no``.
- Pointers will be ``NULL`` when the argument is optional and the user did not - Most pointers will be ``NULL`` when the argument is optional and the
use it. user did not supply it. As noted in the table above, some prefix
struct type arguments are passed as pointers to all-zeroes structs,
not as ``NULL`` pointers.
- If a parameter is not a pointer, but is optional and the user didn't use it, - If a parameter is not a pointer, but is optional and the user didn't use it,
the default value will be passed. Check the ``_str`` argument if you need to the default value will be passed. Check the ``_str`` argument if you need to
determine whether the parameter was omitted. determine whether the parameter was omitted.