diff options
author | Billy McFall <bmcfall@redhat.com> | 2016-09-09 08:46:40 -0400 |
---|---|---|
committer | Dave Wallace <dwallacelf@gmail.com> | 2016-09-13 02:06:48 +0000 |
commit | 22aa3e970da0f0c772c5a16103a5dcf1f2875285 (patch) | |
tree | 5945d6b0dba816d5572ba766e1ddc5246934e5e2 /vnet/vnet/l2/l2_flood.c | |
parent | 1732fc1ab851c454a74efda47a383f48691d545a (diff) |
VPP-288: Documentation changes via doxygen for vnet/vnet/l2.
Change-Id: I55b552fd054610c993d14078ce048c8c4b676104
Signed-off-by: Billy McFall <bmcfall@redhat.com>
Diffstat (limited to 'vnet/vnet/l2/l2_flood.c')
-rw-r--r-- | vnet/vnet/l2/l2_flood.c | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/vnet/vnet/l2/l2_flood.c b/vnet/vnet/l2/l2_flood.c index 05df2a014d9..5e9881bff9f 100644 --- a/vnet/vnet/l2/l2_flood.c +++ b/vnet/vnet/l2/l2_flood.c @@ -30,7 +30,10 @@ #include <vppinfra/hash.h> -/* +/** + * @file + * @brief Ethernet Flooding. + * * Flooding uses the packet replication infrastructure to send a copy of the * packet to each member interface. Logically the replication infrastructure * expects two graph nodes: a prep node that initiates replication and sends the @@ -538,6 +541,17 @@ done: return error; } +/*? + * Layer 2 flooding can be enabled and disabled on each + * interface and on each bridge-domain. Use this command to + * manage interfaces. It is enabled by default. + * + * @cliexpar + * Example of how to enable flooding: + * @cliexcmd{set interface l2 flood GigabitEthernet0/8/0} + * Example of how to disable flooding: + * @cliexcmd{set interface l2 flood GigabitEthernet0/8/0 disable} +?*/ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (int_flood_cli, static) = { .path = "set interface l2 flood", |