3 *************************
4 Bullets, Bold and Italics
5 *************************
7 Bold text can be show with **Bold Text**, Italics with *Italic text*. Bullets like so:
19 A note can be used to describe something not in the normal flow of the paragraph. This
20 is an example of a note.
24 Using **git commit** after adding your files saves a "Snapshot" of them, so it's very hard
25 to lose your work if you *commit often*.
31 This paragraph describes how to do **Console Commands**. When showing VPP commands it is recommended
32 that the command be executed from the linux console as shown. The Highlighting in the final documents
33 shows up nicely this way.
35 .. code-block:: console
38 # vppctl show interface
39 Name Idx State Counter Count
40 TenGigabitEthernet86/0/0 1 up rx packets 6569213
44 TenGigabitEthernet86/0/1 2 down
45 VirtualEthernet0/0/0 3 up rx packets 50384
54 The **code-block** construct is also used for code samples. The following shows how to include a block of
59 #include <vlib/unix/unix.h>
61 abf_policy_get (u32 index)
63 return (pool_elt_at_index (abf_policy_pool, index));
66 Diffs are generated in the final docs nicely with "::" at the end of the description like so::
68 diff --git a/src/vpp/vnet/main.c b/src/vpp/vnet/main.c
69 index 6e136e19..69189c93 100644
70 --- a/src/vpp/vnet/main.c
71 +++ b/src/vpp/vnet/main.c
73 #include <vlib/unix/unix.h>
74 #include <vnet/plugin/plugin.h>
75 #include <vnet/ethernet/ethernet.h>
76 +#include <vnet/ip/ip4_packet.h>
77 +#include <vnet/ip/format.h>
78 #include <vpp/app/version.h>
79 #include <vpp/api/vpe_msg_enum.h>
81 @@ -400,6 +402,63 @@ VLIB_CLI_COMMAND (test_crash_command, static) = {