aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/writingdocs/styleguidemd/styleguide03.md
blob: 4c66dc4de332792e7c1dc192ad577cda15a5823c (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

Labels, References
==================

A link or reference to other paragraphs within these documents can be
done with following construct.

External Links
==============

An external link is done with the following construct:

[Sphinx Markup
Constructs](http://www.sphinx-doc.org/en/stable/markup/index.html)

Images
======

Images should be placed in the directory docs/\_images. They can then be
referenced with following construct. This is the image created to show a
pull request.

![](/_images/examplePullReq.png)

Tables
======

An example of a table in markdown is shown here:

| This Column | This Column   | This Column |
| ------------|:-------------:|------------:|
| is left     | is            | is right    |
| aligned     | centered      | aligned     |
shark uses cmake, so it's relatively easy to build, at least on Ubuntu 18.04. ``` $ cd wireshark $ mkdir build $ cd build $ cmake -G Ninja ../ $ ninja -j 8 $ sudo ninja install ``` Make a pcap dispatch trace -------------------------- Configure vpp to pass traffic in some fashion or other, and then: ``` vpp# pcap dispatch trace on max 10000 file vppcapture buffer-trace dpdk-input 1000 ``` or similar. Run traffic for long enough to capture some data. Save the dispatch trace capture like so: ``` vpp# pcap dispatch trace off ``` Display in Wireshark -------------------- Display /tmp/vppcapture in the vpp-enabled version of wireshark. With any luck, normal version of wireshark will refuse to process vpp dispatch trace pcap files because they won't understand the encap type. Set wireshark to filter on vpp.bufferindex to watch a single packet traverse the forwarding graph. Otherwise, you'll see a vector of packets in e.g. ip4-lookup, then a vector of packets in ip4-rewrite, etc.