From 20b35e468d7d8f80ef7f157e22c5d0f0cccbd134 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 29 May 2018 21:00:59 +0000 Subject: [PATCH] doc: cleanup sharp.rst The user doc index was not displaying correctly because of some syntax errors in sharp.rst Signed-off-by: Quentin Young --- doc/user/sharp.rst | 67 ++++++++++++++++++++++------------------------ 1 file changed, 32 insertions(+), 35 deletions(-) diff --git a/doc/user/sharp.rst b/doc/user/sharp.rst index 090628044c..e27da63b53 100644 --- a/doc/user/sharp.rst +++ b/doc/user/sharp.rst @@ -1,13 +1,13 @@ .. _sharp: -*** +***** SHARP -*** +***** + +:abbr:`SHARP (Super Happy Advanced Routing Process)` is a daemon that provides +miscellaneous functionality used for testing FRR and creating proof-of-concept +labs. -:abbr:`SHARP` Super Happy Advanced Routing Process. This daemon is useful -for the testing of FRR itself as well as useful for creation of Proof of -Concept labs. - .. _starting-sharp: Starting SHARP @@ -26,42 +26,39 @@ documented elsewhere. .. _using-sharp: -USING SHARP +Using SHARP =========== -All sharp commands are under the enable node and proceeded by the -:abbr:`sharp` keyword. There are currently no permenent sharp -commands for configuration. - -..index:: sharp install -..clicmd:: sharp install routes A.B.C.D nexthop E.F.G.H (1-1000000) - -Install up to a million /32 routes starting at A.B.C.D with specified nexthop -E.F.G.H. The nexthop is a NEXTHOP_TYPE_IPV4 and must be reachable to be -installed into the kernel. The routes are installed into zebra as -ZEBRA_ROUTE_SHARP and can be used as part of a normal route redistribution. -Route installation time is noted in the debug log and upon zebra successful -installation into the kernel and sharp receiving the notification of all -route installs the success will be noted in the debug log as well. +All sharp commands are under the enable node and preceeded by the ``sharp`` +keyword. At present, no sharp commands will be preserved in the config. -..index:: sharp remove -..clicmd:: sharp remove routes A.B.C.D (1-1000000) +.. index:: sharp install +.. clicmd:: sharp install routes A.B.C.D nexthop E.F.G.H (1-1000000) -Remove up 1000000 million /32 routes starting at A.B.C.D. The routes are -removed from zebra. Route deletion start is noted in the debug log -and when all routes have been successfully deleted the debug log will -be updated with this information as well. + Install up to 1,000,000 (one million) /32 routes starting at ``A.B.C.D`` + with specified nexthop ``E.F.G.H``. The nexthop is a ``NEXTHOP_TYPE_IPV4`` + and must be reachable to be installed into the kernel. The routes are + installed into zebra as ``ZEBRA_ROUTE_SHARP`` and can be used as part of a + normal route redistribution. Route installation time is noted in the debug + log. When zebra successfully installs a route into the kernel and SHARP + receives success notifications for all routes this is logged as well. -..index:: sharp label -..clicmd:: sharp label vrf NAME label (0-1000000) +.. index:: sharp remove +.. clicmd:: sharp remove routes A.B.C.D (1-1000000) -Install a label into the kernel that causes the specified vrf NAME table to be -used for pop and forward operations when the specified label is seen. + Remove up to 1,000,000 (one million) /32 routes starting at ``A.B.C.D``. The + routes are removed from zebra. Route deletion start is noted in the debug + log and when all routes have been successfully deleted the debug log will be + updated with this information as well. -..index:: sharp watch -..clicmd: sharp watch nexthop +.. index:: sharp label +.. clicmd:: sharp label vrf NAME label (0-1000000) -Instruct zebra to monitor and notify sharp when the specified nexthop is -changed. The notification from zebra is written into the debug log. + Install a label into the kernel that causes the specified vrf NAME table to + be used for pop and forward operations when the specified label is seen. +.. index:: sharp watch +.. clicmd:: sharp watch nexthop + Instruct zebra to monitor and notify sharp when the specified nexthop is + changed. The notification from zebra is written into the debug log. -- 2.39.5