History log of /vpp/docs/
Revision Date Author Comments
(<<< Hide modified files)
(Show modified files >>>)
dee0a3bb 10-Feb-2020 Dave Barach <dave@barachs.net>

http_static: VPP web application HowTo

This sketch should save a lot of time working out uninteresting but
important details.

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Icd5705230adfda6539360ef3c46ff3a68b3bed74

78a18774 31-Jan-2020 Dave Barach <dave@barachs.net>

vppinfra: write up clib_time_t

Describe the clock rate adjustment algorithm in detail

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I5bcab18efafe05cd1db9a4b01ce6a6ba66e383fa

a273ce62 24-Jan-2020 John DeNisco <jdenisco@cisco.com>

docs: Update the requirements and fix the build

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: I30e37f7e549083337b11ace95b4ff4f427d9fc8c

87e64c92 29-Nov-2019 Benoît Ganne <bganne@cisco.com>

docs: add AddressSanitizer mini-howto

Type: docs

Change-Id: I3bb589d04f15a03166a6d457552ffc316fb02f94
Signed-off-by: Benoît Ganne <bganne@cisco.com>

affa0553 22-Oct-2019 Jieqiang Wang <jieqiang.wang@arm.com>

docs: add physmem section in configuration parameters

physmem section is listed in 'Advanced Parameters', which has two
parameters, base-addr and max-size, for pmalloc module in VPP.

Type:feature

Change-Id: I7beef40603b864e4c8f3cf0fa716de74036cfdcc
Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>

917c91ad 07-Nov-2019 Paul Vinciguerra <pvinci@vinciconsulting.com>

docs: update troubleshooting commands

Depends-On: https://gerrit.fd.io/r/c/vpp/+/22819

Type: docs

Change-Id: I1e2170a524e19cb91836a8073f62100b88f46cee
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>

328631d4 17-Dec-2019 Dave Barach <dave@barachs.net>

docs: improve compressed core file documentation

In particular, document "zcat vpp_core.gz | dd conv=sparse of=vpp_core"

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I01b70492ced864b47847c2ef7bc1ea8eb0980ec3

4f85968a 10-Dec-2019 John DeNisco <jdenisco@cisco.com>

docs: Rework the startup configuration section

Type: docs

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ic60aac96a4aeb5532f98dfb85c776bf549c0d660
Signed-off-by: Dave Barach <dave@barachs.net>

87d24db6 04-Dec-2019 Dave Barach <dave@barachs.net>

classify: vpp packet tracer support

Configure n-tuple classifier filters which apply to the vpp packet
tracer.

Update the documentation to reflect the new feature.

Add a test vector.

Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Iefa911716c670fc12e4825b937b62044433fec36

d28437cd 20-Nov-2019 Dave Barach <dave@barachs.net>

classify: per-interface rx/tx pcap capture filters

Finish the feature, and fix a couple of doc bugs

Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I2c62745fda137776204c8fc4fca0e7e288051573

867b9ec6 11-Nov-2019 Paul Vinciguerra <pvinci@vinciconsulting.com>

docs: update logging configuration section.

Type: docs

Change-Id: I6359623b2eadb404fc391e4c4608fff86020f53f
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>

c96d618a 06-Nov-2019 John DeNisco <jdenisco@cisco.com>

docs: Rewrite the what is VPP (first) section, also fix the build

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ifb558171f8976a721703e74afea997d006273b5f
Signed-off-by: Dave Barach <dave@barachs.net>

340c15c6 05-Nov-2019 Paul Vinciguerra <pvinci@vinciconsulting.com>

docs: add spellcheck to 'make docs' sphinx docs

The CI gate will fail if there are typos in the docs.

writing output... [ 21%] events/Summits/OpensourceSummit...
writing output... [ 22%] events/Summits/UKNO/2017_04_30_...

featuresbyrelease/vpp16.06.rst:34:Rasberry:vpp16.06
writing output... [100%] usecases/vppinazure
Spelling checker messages written to /vpp/docs/_build/html/output.txt

Warning, treated as error:
Found 1 misspelled words
Makefile:31: recipe for target 'html' failed
make[1]: *** [html] Error 2
make[1]: Leaving directory '/vpp/docs'

If you introduce a term that is not recognized,
please add it to custom dictionary at
docs/spelling_wordlist.txt.

Type: feature

Change-Id: Id49be4fbee617f544f1ab8e78e7de8a4df36448b
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>

73f725c6 29-Oct-2019 John DeNisco <jdenisco@cisco.com>

docs: Fix warning with sphinx build, add script to publish docs

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ic17585bcb4196e5b0661104745f67d6a02ab6b3d

7fa3dd28 27-Oct-2019 Paul Vinciguerra <pvinci@vinciconsulting.com>

docs: cleanup typos on readthrough

Type: style

Change-Id: I3b15035ea6c13cd1ca3cdc9dfa9b10a6e1be9880
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>


featuresbyrelease/vpp1908.md
gettingstarted/developers/bihash.md
gettingstarted/developers/binary_api_support.rst
gettingstarted/developers/building.rst
gettingstarted/developers/buildsystem/buildrootmakefile.rst
gettingstarted/developers/fib20/dataplane.rst
gettingstarted/developers/fib20/graphwalks.rst
gettingstarted/developers/fib20/routes.rst
gettingstarted/developers/fib20/scale.rst
gettingstarted/developers/fib20/tunnels.rst
gettingstarted/developers/gdb_examples.rst
gettingstarted/developers/infrastructure.md
gettingstarted/developers/metadata.md
gettingstarted/developers/multiarch/index.rst
gettingstarted/developers/vnet.md
gettingstarted/developers/vpp_api_module.rst
gettingstarted/progressivevpp/index.rst
gettingstarted/progressivevpp/switching.rst
gettingstarted/progressivevpp/twovppinstances.rst
gettingstarted/users/configuring/hugepages.rst
gettingstarted/users/configuring/startup.rst
gettingstarted/users/configutil/sysinfo.rst
gettingstarted/writingdocs/styleguide/index.rst
gettingstarted/writingdocs/styleguide/styleguide02.rst
gettingstarted/writingdocs/styleguide/styleguide04.rst
gettingstarted/writingdocs/styleguidemd/styleguide02.md
overview/features/l2.rst
overview/performance/index.rst
overview/whatisvpp/dataplane.rst
overview/whatisvpp/developer.rst
overview/whatisvpp/extensible.rst
overview/whatisvpp/what-is-vector-packet-processing.rst
reference/cmdreference/index.rst
reference/cmdreference/interface/create_interface.rst
reference/cmdreference/show/show.rst
reference/cmdreference/vhost/vhostuser.rst
reference/vppvagrant/Vagrantfile
reference/vppvagrant/boxSetup.rst
usecases/ConnectingVPC.rst
usecases/Routing.rst
usecases/acls.rst
usecases/automatingthedeployment.rst
usecases/contiv/BUG_REPORTS.md
usecases/contiv/K8s_Overview.md
usecases/contiv/MANUAL_INSTALL.md
usecases/contiv/MULTI_NIC_SETUP.md
usecases/contiv/VPP_PACKET_TRACING_K8S.md
usecases/simpleperf/iperf3.rst
usecases/simpleperf/trex2.rst
usecases/vmxnet3.rst
usecases/vppinazure.rst
66f2a889 31-Jul-2019 Nathan Skrzypczak <nathan.skrzypczak@gmail.com>

docs: Add macos build documentation

Type: docs

Change-Id: Iee03aacab2cfcb4e87190302dc641e8273b7f096
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>

56f62afe 06-Oct-2019 Dave Barach <dave@barachs.net>

docs: grammar police raid

Edit the front-page intro text. Fix egregious grammar errors,
including an "it's" vs. "its" blunder.

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: If9d7d07899c402cd49bbae988110a15216035b02

66a332cf 04-Oct-2019 Dave Barach <dave@barachs.net>

docs: add packet-generator writeup

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I4abb5c17e6fdfeaed5bbadb2ce83098dde6d05b1

f5667c30 25-Sep-2019 Dave Barach <dave@barachs.net>

misc: add vnet classify filter set support

Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I79b216d2499df143f53977e5b70382f6f887e0bc

33909777 23-Sep-2019 Dave Barach <dave@barachs.net>

misc: unify pcap rx / tx / drop trace

Use a single vnet_pcap_t in vlib_global_main, specifically to support
unified tracing

Update sphinx docs, doxygen tags

Type: refactor
Ticket: VPP-1776

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Id15d41a596712968c0714cef1bd2cd5bc9cbdd55

9137e540 13-Sep-2019 Dave Barach <dave@barachs.net>

misc: classifier-based packet trace filter

See .../src/vnet/classify/trace_classify.h for the business end
of the scheme.

It would be best to hash pkts, prefetch buckets, and do the primary
table lookups two at a time. The inline as given works, but perf
tuning will be required. "At least it works..."

Add "classify filter" debug cli, for example:
classify filter mask l3 ip4 src dst \
match l3 ip4 dst 192.168.2.10 src 192.168.1.10

Add "pcap rx | tx trace ... filter" to use the current classify filter chain

Patch includes sphinx documentation and doxygen tags.

Next step: device-driver integration

Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I05b1358a769f61e6d32470e0c87058f640486b26

8b1c7f34 11-Sep-2019 jdenisco <jdenisco@cisco.com>

docs: run-sphinx-docs-merged

Type: docs

Signed-off-by: jdenisco <jdenisco@cisco.com>
Change-Id: I571222f3e3672253930700e23cca4812dde84a6d

5b786fb8 09-Sep-2019 Dave Barach <dave@barachs.net>

docs: improve unformat documentation

Specifically: document the unformat specifiers "%=", "%|", and correct
usage of unformat_line_input.

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I254f9c4a61c5c8d3edbf76f521e5f38fb89150f1

61b28ba6 20-Aug-2019 Andrew Yourtchenko <ayourtch@gmail.com>

misc: 19.08 new features

The full RELEASE.md diff is b610f2022c9f4e10a922e7b57c80ec77cd45d021

Change-Id: Ide6d85d41bdc836a03390a50ab94f6ebbaae0b28
Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
(cherry picked from commit 1c586de48cc76fc6eac50f5d87003e2a80aa43e7)

c5423577 30-Jul-2019 jdenisco <jdenisco@cisco.com>

docs: Add Ray's ACL use case

Change-Id: Id99f16953a23a4be4cc1fb94419ea8282fa720e8
Signed-off-by: jdenisco <jdenisco@cisco.com>

6595ff7f 07-Aug-2019 Ole Troan <ot@cisco.com>

api: api socket respect unix runtime directory

socksvr {} should respect the unix runtime directory.
Default is now /run/vpp/api.sock
The 'default' keyword is deprecated.
The user is responsible for creating directories outside of the
unix runtime directory.

Not yet done: Exit VPP when socket cannot be opened.
(currently only process exits).

Type: fix
Signed-off-by: Ole Troan <ot@cisco.com>
Change-Id: I6dd66ed58a3d7e02674dfa16d72c1d7bba07b79e

7858d6e9 29-Jul-2019 Nathan Skrzypczak <nathan.skrzypczak@gmail.com>

docs: Add more quic plugin documentation

Type: docs

Change-Id: I0209769f73a46ddad7c2625ad0f774ee2eef43dd
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>

55c68c95 29-Jul-2019 Nathan Skrzypczak <nathan.skrzypczak@gmail.com>

docs: Small fixes and ordering

* deactivtates the TODOs on doxygen (were empty)
* This move punt.md to readthedocs (should be the new
place for dev doc ?)
* Makes Handoff queue demo plugin a child of dev doc
in doxygen

Type: fix

Change-Id: I1f0476a911b35208212af8dd608bc76160efd22a
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>

af57799f 26-Jul-2019 Dave Barach <dave@barachs.net>

docs: add binary api trace replay details

Folks need to know that they MUST carefully control the set of plugins
to avoid feeding messages to the wrong binary API message handlers.

Change-Id: Iefeeda6670aae4627446caee21717b847305c9b5
Signed-off-by: Dave Barach <dave@barachs.net>

d455e5a2 22-Jul-2019 Dave Barach <dave@barachs.net>

docs: improve home gateway use-case documentation

Add plugin config, systemd config, netplan config, software
installation via ssh, and a quick HowTo for setting up a double-nat
test gateway.

Fix a minor doc bug which caused a complaint on vpp-dev@lists.fd.io:
/etc/vpp/startup.conf -> /setup.gate, but the vpp configuration file
wasn't explicitly tagged with the name /setup.gate.

Type: docs

Change-Id: Ib219040d7c3c8b50ed66f8e9d3afd3dcf51b6b7b
Signed-off-by: Dave Barach <dave@barachs.net>

675c2396 19-Jul-2019 jdenisco <jdenisco@cisco.com>

docs: Fix conf.py for read the docs

Change-Id: Iaaf9e6ef5acc82fb751c851cc943cf0c48a8940d
Signed-off-by: jdenisco <jdenisco@cisco.com>

edff8054 12-Jul-2019 Dave Barach <dave@barachs.net>

docs: add compressed core file description

To the issue reporting page

Change-Id: I3d2b53521bcb1b9b4a85802a84427f17390f0f77
Type: docs
Signed-off-by: Dave Barach <dave@barachs.net>

6d72c175 04-Jul-2019 Benoît Ganne <bganne@cisco.com>

docs: how to enable coredump with systemd

Type: docs

Change-Id: I1f657389fec716cc6cdc942803e65f861ffea5f5
Signed-off-by: Benoît Ganne <bganne@cisco.com>

08b8ce1d 26-Jun-2019 jdenisco <jdenisco@cisco.com>

docs: Update the vhost section

Change-Id: Ic7a144ffda0d0a3e0f6f9bc1a4790ab36fdf002e
Signed-off-by: jdenisco <jdenisco@cisco.com>

05cac30a 28-May-2019 Neale Ranns <nranns@cisco.com>

FIB: correctly report IPv6 FIB Unicast and Multicast memory usage (VPP-1578)"

and document scaling

Change-Id: I65d8999e65616d77e525963c770d91e9b0d5e593
Signed-off-by: Neale Ranns <nranns@cisco.com>

65e410b3 28-May-2019 jdenisco <jdenisco@cisco.com>

docs: Add some packages for building the docs

Change-Id: I7af427ba6378ddd8480a153a65ec11c578bab12e
Signed-off-by: jdenisco <jdenisco@cisco.com>

3bfeff7a 17-May-2019 jdenisco <jdenisco@cisco.com>

docs: Fix Versions and Titles

Change-Id: I131e33a570bff8b22c767585d03e2eb281dd7184
Signed-off-by: jdenisco <jdenisco@cisco.com>

8a6e1b19 13-May-2019 jdenisco <jdenisco@cisco.com>

docs: Update sphinx, requirements, support markdown tables

Change-Id: Ie7c546f5720b10fe5423397204e1ab5c22d7a2ba
Signed-off-by: jdenisco <jdenisco@cisco.com>

8fa01c17 16-May-2019 Dave Barach <dave@barachs.net>

DOC ONLY: document VLIB_INIT_FUNCTION scheme

Change-Id: I15c4256621da6c8d47b1a7c41755ee6587996757
Signed-off-by: Dave Barach <dave@barachs.net>

0da895df 01-May-2019 jdenisco <jdenisco@cisco.com>

docs: Add 1904

Change-Id: Icf0e01d1dec69d48664ed633205248359b653f4d
Signed-off-by: jdenisco <jdenisco@cisco.com>

c4a0afe5 21-Apr-2019 Dave Wallace <dwallacelf@gmail.com>

Sphinx docs: Fix security vulnerability (VPP-1655)

Change-Id: I9b11d15866d708eb843936ebfd120940d284a2de
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
(cherry picked from commit facb4d44475cd0040cc8964be30180e1adeb2021)

bcfcb8e7 29-Apr-2019 Dave Barach <dave@barachs.net>

DOC ONLY: add a buffer metadata writeup

Change-Id: Ic8034cfe3d3c5a9c3d32e97e93e5d9334cc58ca2
Signed-off-by: Dave Barach <dave@barachs.net>

22e9c03a 28-Feb-2019 Francesco Spinelli <francescospinelli94@live.it>

docs: Add VPP inside the Cloud

This commit updates the VPP docs, adding the VPP deployment and configuration inside the cloud

Change-Id: I97322deb57f0dfb1aa46cca301adbc91ce4a19f6
Signed-off-by: Francesco Spinelli <francescospinelli94@live.it>

f324dec0 08-Apr-2019 Jim Thompson <jim@netgate.com>

fixing typos

Change-Id: I215e1e0208a073db80ec6f87695d734cf40fabe3
Signed-off-by: Jim Thompson <jim@netgate.com>

6c1f56f0 22-Mar-2019 Dave Barach <dave@barachs.net>

DOC-ONLY: improve multi-arch documentation

Document CLIB_MARCH_FN and CLIB_MARCH_FN_SELECT

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I661ba2af79db8205d70fa87203d40a2e31b795e4

1ea74b5d 19-Mar-2019 Steven Luong <sluong@cisco.com>

docs: break up long lines in vmxnet3.rst to avoid line wrap

Although it does not make a difference for the formatter with long lines, it
is easier to view and read the raw text with conventional editor when there no
line wrap. Just break up the long lines to 80 characters or less.

Change-Id: Ia916638e974abd19b8d19aee4dd72ff6a243ca48
Signed-off-by: Steven Luong <sluong@cisco.com>

ee94ffa3 14-Mar-2019 Steven Luong <sluong@cisco.com>

docs: Update vmxnet3 usecase

Update vmxnet3 usecase to reflect the current supported features.

Change-Id: I4558eb422d5b2641b3acfc7c0a3734bf31a8fb0f
Signed-off-by: Steven Luong <sluong@cisco.com>

3fef8f81 15-Mar-2019 Dave Barach <dave@barachs.net>

DOC ONLY: fix g2 build documentation

Removed a broken paragraph, replaced it with a link.

Some nuisance white-space cleanups courtesy of emacs:
(add-hook 'before-save-hook 'delete-trailing-whitespace)

Change-Id: Ib348107c2dc0df8249461591015347d7b4f6fa4a
Signed-off-by: Dave Barach <dave@barachs.net>

c4be9850 12-Mar-2019 Dave Barach <dave@barachs.net>

DOC ONLY: add packet handoff doc

Change-Id: I2e8076bb4f697819780e61ff761defdc74bf4f09
Signed-off-by: Dave Barach <dave@barachs.net>

e8692691 26-Feb-2019 jdenisco <jdenisco@cisco.com>

Fix centos build and build documentation

Change-Id: I326204d26b613254e39c6a0ffe9f9491981ba3c3
Signed-off-by: jdenisco <jdenisco@cisco.com>

b93452b5 27-Feb-2019 Dave Barach <dave@barachs.net>

DOC ONLY: update bug report section

More detail on why it's important to supply .debs or .rpms which
precisely match core files. Probably won't help, but we can try...

Change-Id: I7842eaea0ef921b934e84b7f18f6a333b1381292
Signed-off-by: Dave Barach <dave@barachs.net>

2cefb064 19-Feb-2019 jdenisco <jdenisco@cisco.com>

Add support for 19.01

Change-Id: I8583f6f6432d8d7c449f43d62d8707a1718f3240
Signed-off-by: jdenisco <jdenisco@cisco.com>

0be7451d 14-Feb-2019 Paul Vinciguerra <pvinci@vinciconsulting.com>

docs: use python3 for make docs.

Change-Id: If62b5ef563523b400fb5160d0343210407905094
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>

4e633e10 31-Jan-2019 Michal Cmarada <mcmarada@cisco.com>

VPP-1504: Remove JVPP

As part of JVPP migration this removes JVPP completely from VPP.

Change-Id: I6b74e7961aa474ae471e63fe43a624cd9fc3659b
Signed-off-by: Michal Cmarada <mcmarada@cisco.com>

f5de036c 30-Jan-2019 jdenisco <jdenisco@cisco.com>

docs: Instructions for using vmxnet3 on mac

Change-Id: Ie6770e3a3801a23a6eb64cf1699ef0018eab6445
Signed-off-by: jdenisco <jdenisco@cisco.com>

6434430f 19-Jan-2019 Damjan Marion <damarion@cisco.com>

buffers: don't init metadata, as it is already initialized

Change-Id: Ia083050389853c25b069f0f8286d50d3f4aef527
Signed-off-by: Damjan Marion <damarion@cisco.com>

1d052d2e 17-Jan-2019 Dave Barach <dave@barachs.net>

DOC ONLY: wireshark dissector upstreamed

Remove the last remnant from extra/wireshark, update the Sphinx docs

Change-Id: I5886557f17192475c03fcb0dfde581e1e63cea5c
Signed-off-by: Dave Barach <dave@barachs.net>

8dc146e0 06-Jan-2019 Dave Barach <dave@barachs.net>

Update tcpdump / wireshark packet format writeup

Change-Id: I8195bae1421f68a823b86e12373840f5292ac0df
Signed-off-by: Dave Barach <dave@barachs.net>

82b22f75 17-Dec-2018 jdenisco <jdenisco@cisco.com>

docs: Add vmxmet3 driver

Change-Id: I96425804c310a1ac1b7f5f12bb636e591c7bd429
Signed-off-by: jdenisco <jdenisco@cisco.com>

4659d0e8 13-Dec-2018 Dave Wallace <dwallacelf@gmail.com>

docs: clarify vector element alignment description.

Change-Id: I6da153779010263e6fc4b51c64b01444aaadca17
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>

6f666ad9 12-Dec-2018 jdenisco <jdenisco@cisco.com>

docs: Update the requirements

Change-Id: I80ea8a65317805c6542e338a92a21e6090f6c015
Signed-off-by: jdenisco <jdenisco@cisco.com>

10c5ff14 06-Dec-2018 Dave Barach <dave@barachs.net>

nsim: add packet loss simulation, docs

Change-Id: Ic9747541aad8148ebf7d520b525b99c4cc3961f3
Signed-off-by: Dave Barach <dave@barachs.net>

995ff06f 06-Dec-2018 Neale Ranns <nranns@cisco.com>

DOC-ONLY: MFIB documentation

Change-Id: I8c7277584f231dd4732a4c6013e156a5bb821f41
Signed-off-by: Neale Ranns <nranns@cisco.com>

01fdbcca 04-Dec-2018 Dave Barach <dave@barachs.net>

DOC ONLY: describe dispatch pcap tracing

and wireshark dissection of these traces.

Change-Id: I61029fd20d6d5f6c40638e3ea9223f2354abedba
Signed-off-by: Dave Barach <dave@barachs.net>

ad4426e5 26-Nov-2018 jdenisco <jdenisco@cisco.com>

docs: Add more on trex

Change-Id: Ifb5eabe30e1b0ba911ddf455573cc346ff4bec85
Signed-off-by: jdenisco <jdenisco@cisco.com>

2a7b546f 23-Nov-2018 Yulong Pei <yulong.pei@intel.com>

doc: delete wrong description since VPP support 1G hugepage

Change-Id: Ib673f8059f47d8e2e86ad810a354ddf630f557cf
Signed-off-by: Yulong Pei <yulong.pei@intel.com>

24010fba 13-Nov-2018 jdenisco <jdenisco@cisco.com>

docs and Config utility, package cloud support

Change-Id: I61303242b73e509df42dedba54f2ee5906a7e526
Signed-off-by: jdenisco <jdenisco@cisco.com>

a3d5986a 10-Nov-2018 Damjan Marion <dmarion@me.com>

vlib rename vlib_frame_args(...) to vlib_frame_scalar_args(..)

Typically we have scalar_size == 0, so it doesn't matter
but vlib_frame_args was providing pointer to scalar frame
data, not vector data. To avoid future confusion function
is renamed to vlib_frame_scalar_args(...)

Change-Id: I48b75523b46d487feea24f3f3cb10c528dde516f
Signed-off-by: Damjan Marion <damarion@cisco.com>

569a2785 09-Nov-2018 jdenisco <jdenisco@cisco.com>

docs: add 1810, including package cloud

Change-Id: Ieae5fc7c1e099392bc2a4e5948669d9210f2ebac
Signed-off-by: jdenisco <jdenisco@cisco.com>

65ed2d05 06-Nov-2018 jdenisco <jdenisco@cisco.com>

docs: Add version and build date

Change-Id: I6fd53d3ef12e4b6f1af1e5605c09938bce324ec9
Signed-off-by: jdenisco <jdenisco@cisco.com>

390036e0 31-Oct-2018 jdenisco <jdenisco@cisco.com>

docs: Small changes to plugin, updated the requirements

Change-Id: I3c05a28991d01e726d4fa8580a720359a2d4ce91
Signed-off-by: jdenisco <jdenisco@cisco.com>

5e36c3cd 30-Oct-2018 Dave Barach <dave@barachs.net>

DOC-ONLY: document packet intialization from scratch

Minor clean-up in the home gateway use-case documentation

Change-Id: I7d3aaea8cec62248daf7814b21a8acb574ac12a1
Signed-off-by: Dave Barach <dave@barachs.net>

1511a4e9 30-Oct-2018 jdenisco <jdenisco@cisco.com>

docs: Add VPP with iperf and trex

Change-Id: I9f238b6092bc072fd875facfee5262c6b155043e
Signed-off-by: jdenisco <jdenisco@cisco.com>

949bbbc7 30-Oct-2018 Dave Barach <dave@barachs.net>

DOC-ONLY: upgrade the "requests" package

requests 2.18.4 is the subject of a security alert

Change-Id: Id1e9338d86bced8c0bb065db7b3dc7f02aa41afc
Signed-off-by: Dave Barach <dave@barachs.net>

6c892301 26-Oct-2018 Scott Keeler <skeeler@cisco.com>

docs: add useful debug CLI Review Updates

Change-Id: I4ebd977672090f2a7fc08bb139832df39614564a
Signed-off-by: Scott Keeler <skeeler@cisco.com>

70f28fc4 23-Oct-2018 Scott Keeler <skeeler@cisco.com>

docs: add useful debug CLI

Change-Id: I5ef9ecd741f1623ae1b7a23fa0a4fa6db7e243a3
Signed-off-by: Scott Keeler <skeeler@cisco.com>

8a692893 24-Oct-2018 Dave Barach <dave@barachs.net>

DOC ONLY: fix doc bugs

multiarch support: change autotools -> cmake
getting a patch reviewed: improve patch conflict resolution section

Change-Id: I2f07e1d3f21dd8cefb4d4bb3b451965d9314211a
Signed-off-by: Dave Barach <dave@barachs.net>

1cce2717 26-Sep-2018 Lijian Zhang <Lijian.Zhang@arm.com>

add Contiv-VPP installation guidance on Aarch64

add Contiv-VPP installation guidance on Aarch64

Change-Id: I323c871d346c47396916a618934c5e169ee49212
Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Song Zhu <Song.Zhu@arm.com>
Reviewed-by: Trevor Tao <Trevor.Tao@arm.com>
Reviewed-by: Sirshak Das <Sirshak.Das@arm.com>
Reviewed-by: Tina Tsou <Tina.Tsou@arm.com>

f9faf242 04-Oct-2018 Dave Barach <dave@barachs.net>

DOC ONLY: clean up plugin documentation

The old "sample_plugin" page was stuffed with superceded autotools
build information, so it morphed into an "add a new plugin" page based
on the emacs-lisp plugin generator.

Before sending hate mail about emacs, please *look* at the new
document: you'll find running the plugin generator hard to tell from
running a shell script.

Change-Id: I84da45675e838c05faeca05c8f7be45d8c7bff13
Signed-off-by: Dave Barach <dave@barachs.net>

25c4d396 01-Oct-2018 Scott Keeler <skeeler@cisco.com>

docs: add contiv vpp

Change-Id: I92227fc4968fc6a478beb7f38707b91e9f0635ec
Signed-off-by: Scott Keeler <skeeler@cisco.com>

3138d723 24-Sep-2018 jdenisco <jdenisco@cisco.com>

Add the sphinx docs build options

Change-Id: If7ac5b41ca4ac602a100b616b37d07f658fd6a90
Signed-off-by: jdenisco <jdenisco@cisco.com>

45e1cd92 17-Sep-2018 jdenisco <jdenisco@cisco.com>

docs: Added Related Projects and Archive

Change-Id: I9a6076aa53d810ec44761d9f9459eb91f2c05974
Signed-off-by: jdenisco <jdenisco@cisco.com>

79dcbc74 12-Sep-2018 Damjan Marion <damarion@cisco.com>

Always use 'lib' instead of 'lib64'

It is packaging responsibility to put libs in the right place.
Use of lib64 resulted in huge amount of files with hardcoded lib64.
This patch simplifies things...

Change-Id: Iab0dea0583e480907732c5d2379eb951a00fa9e6
Signed-off-by: Damjan Marion <damarion@cisco.com>

d9668e71 06-Sep-2018 Scott Keeler <skeeler@cisco.com>

docs: what is vpp and features and performance

Change-Id: I5a9ae39ed0429b3de001b5109268d577a281cd46
Signed-off-by: Scott Keeler <skeeler@cisco.com>

ecbe6f5e 04-Sep-2018 Dave Barach <dave@barachs.net>

DOC ONLY: cmake / ninja build system doc

Change-Id: I69cdcf3f0940f8a5f60203034688a0c63446f65c
Signed-off-by: Dave Barach <dave@barachs.net>

75c276f9 31-Aug-2018 Neale Ranns <nranns@cisco.com>

Docs: update MPLS FIB section with text from the wiki

Change-Id: I9d903db89facc916fb5dd23d564417230e1c76e0
Signed-off-by: Neale Ranns <nranns@cisco.com>

d9b2fceb 30-Aug-2018 Scitt Keeler <skeeler@cisco.com>

docs: Add features by release section

Change-Id: Ibcae8c8ecdf8a3c2d7bcf96bf7cd5b741e2fad22
Signed-off-by: Scitt Keeler <skeeler@cisco.com>

0923a237 29-Aug-2018 jdenisco <jdenisco@cisco.com>

docs: FIB 2.0 start

Change-Id: I87cd2eae133c9f5b9f7764a0f7a41bcc28523e4c
Signed-off-by: jdenisco <jdenisco@cisco.com>

2ba9dcf4 23-Aug-2018 John DeNisco <jdenisco@cisco.com>

docs: Finish event logger, viewer and cleanup.

Change-Id: I3de038439bf0ab5755777c0f4930aec0514f5b63
Signed-off-by: John DeNisco <jdenisco@cisco.com>

a5db42f3 17-Aug-2018 John DeNisco <jdenisco@cisco.com>

docs: Moved installing up a level, removed guides.

Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b
Signed-off-by: John DeNisco <jdenisco@cisco.com>

4af47b89 07-Aug-2018 Lijian Zhang <Lijian.Zhang@arm.com>

Update AArch64 CSIT machines into FD.io VPP docs

The outlook will appear as below.
The FD.io CSIT is implemented with below platforms:

x86/64
ARM-AArch64

Huawei TaiShan 2280
Marvell MACCHIATObin

Change-Id: Ie84a99c53a0fc2186ea6992baca9558b6d96c7f8
Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>

c4c72d28 16-Aug-2018 John DeNisco <jdenisco@cisco.com>

docs: Rework the VPP progressive Tutorial.

Change-Id: If5b0d07ea90d978c6b1f11210a661876b7929653
Signed-off-by: John DeNisco <jdenisco@cisco.com>

ce96dda4 14-Aug-2018 John DeNisco <jdenisco@cisco.com>

DOCS: Moved multiarch and build system, Incorprated Scott's changes

Change-Id: I5a57846db2d4faac1aa24db4629b612657f59afb
Signed-off-by: John DeNisco <jdenisco@cisco.com>

9f0c0205 14-Aug-2018 andrew <andrew.olechtchouk@gmail.com>

DOCS: Updated startup.conf parameters

Change-Id: Id1f4ff7409e8a833b8f7e6030d7287d8c1274c2d
Signed-off-by: andrew <andrew.olechtchouk@gmail.com>

758dc460 13-Aug-2018 John DeNisco <jdenisco@cisco.com>

DOCS: Cleanup Getting Started

Change-Id: I4766773779f8d5c30a24bfed48090d7305c80ec5
Signed-off-by: John DeNisco <jdenisco@cisco.com>

f46663c6 10-Aug-2018 Dave Barach <dave@barachs.net>

DOC-ONLY: document latest multi-arch support scheme

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I613415c109f648248ee04dd76d5e652dbf21bc7f

8e83bcb9 09-Aug-2018 Dave Barach <dave@barachs.net>

DOC-ONLY: build system details

The tables need some TLC from someone familiar with making pretty
tables.

Fixed text-wrapping onto newlines for all tables in our docs.
Changed Environment Variables to ENV Variables so that the specific
column header fits properly.

Change-Id: Ie758612e561eefe44e771dac63b63bf026a52c2d
Signed-off-by: Dave Barach <dave@barachs.net>

a38d001c 06-Aug-2018 andrew <andrew.olechtchouk@gmail.com>

docs: A little cleanup and added some gdb examples.
docs: Added section on running VPP for developers.

Change-Id: I98b5c6f1c9fee60b297e3947e78ec33f950f598a
Signed-off-by: andrew <andrew.olechtchouk@gmail.com>

df50b45e 09-Aug-2018 andrew <andrew.olechtchouk@gmail.com>

DOCS: General cleanup (did not move any sections)

Change-Id: I67cc42769661c10d2793f8c6cdb3b232b803d145
Signed-off-by: andrew <andrew.olechtchouk@gmail.com>

7d84c16e 09-Aug-2018 javierfernandezvalles <JaviervallesF@gmail.com>

DOCS: modified writing docs section

Change-Id: Ic3ec16dba1a6374785f25f622b2cdc9b6415a13b
Signed-off-by: javierfernandezvalles <JaviervallesF@gmail.com>

faa93008 08-Aug-2018 John DeNisco <jdenisco@cisco.com>

DOCS: Restructure Events

Change-Id: I135ced20b58cdb72fbd0784015af037bb6e7ad28
Signed-off-by: John DeNisco <jdenisco@cisco.com>


events/Community/TSC/2016_04_28_pariseventproposal.rst
events/Community/TSC/index.rst
events/Community/VPP/2017_04_25_buildingincontainerspoc.rst
events/Community/VPP/index.rst
events/Conferences/CiscoLiveUS/2017_06_26_vppcontainernetwork.rst
events/Conferences/CiscoLiveUS/index.rst
events/Conferences/Linuxcon/2016_08_24_introfdio.rst
events/Conferences/Linuxcon/2016_08_24_onelispintro.rst
events/Conferences/Linuxcon/index.rst
events/Conferences/OSCON/2017_05_11_40gbpsipsec.rst
events/Conferences/OSCON/index.rst
events/IntelSDN/2017_06_13_clearcontainers.rst
events/IntelSDN/2017_06_13_fdiooverview.rst
events/Linuxcon/2016_08_24_introfdio.rst
events/Linuxcon/2016_08_24_onelispintro.rst
events/MeetUps/FDIOVPPTerabit/2017_07_11_fdiouniversalterabitnetwork.rst
events/MeetUps/FDIOVPPTerabit/index.rst
events/MeetUps/IntelSDN/2017_06_13_clearcontainers.rst
events/MeetUps/IntelSDN/2017_06_13_fdiooverview.rst
events/MeetUps/IntelSDN/index.rst
events/MeetUps/TWS/2016_08_30_introtodpdkcryptoandvpp.rst
events/MeetUps/TWS/index.rst
events/MeetUps/fdioWebinar/2016_05_25_softwaredataplanes.rst
events/MeetUps/fdioWebinar/index.rst
events/OpNFV/OPNFVSummit/2016_06_21_roadmap.rst
events/OpNFV/OPNFVSummit/2016_06_21_s4_dataplane.rst
events/OpNFV/OPNFVSummit/2016_06_21_s5_serviceassurance.rst
events/Summits/DPDKSummit/2016/2016_08_10_tldkintro.rst
events/Summits/DPDKSummit/2016/index.rst
events/Summits/DPDKSummit/2017/2017_11_15_dpdkvppandpfsense.rst
events/Summits/DPDKSummit/2017/2017_11_15_vpphoststack.rst
events/Summits/DPDKSummit/2017/index.rst
events/Summits/DPDKSummit/index.rst
events/Summits/FDioMiniSummit/KubeCon_2017/2017_12_5_VPPHost.rst
events/Summits/FDioMiniSummit/KubeCon_2017/2017_12_5_armrallying.rst
events/Summits/FDioMiniSummit/KubeCon_2017/2017_12_5_benchmarking.rst
events/Summits/FDioMiniSummit/KubeCon_2017/2017_12_5_empoweringuserspacestack.rst
events/Summits/FDioMiniSummit/KubeCon_2017/index.rst
events/Summits/FDioMiniSummit/OSS_2017/2017_05_10_performanceconsideration.rst
events/Summits/FDioMiniSummit/OSS_2017/index.rst
events/Summits/FDioMiniSummit/index.rst
events/Summits/OpNFV/OPNFVCSIT/2017_02_01_fdiocsitoverview.rst
events/Summits/OpNFV/OPNFVCSIT/index.rst
events/Summits/OpNFV/OPNFVSummit/2016_06_21_roadmap.rst
events/Summits/OpNFV/OPNFVSummit/2016_06_21_s1_introduction.rst
events/Summits/OpNFV/OPNFVSummit/2016_06_21_s2_nfvvirtualswitching.rst
events/Summits/OpNFV/OPNFVSummit/2016_06_21_s3_sdncontroller.rst
events/Summits/OpNFV/OPNFVSummit/2016_06_21_s4_dataplane.rst
events/Summits/OpNFV/OPNFVSummit/2016_06_21_s5_serviceassurance.rst
events/Summits/OpNFV/OPNFVSummit/index.rst
events/Summits/OpNFV/OpNFVtechnicalwork/2016_03_30_IntroFdio.rst
events/Summits/OpNFV/OpNFVtechnicalwork/index.rst
events/Summits/OpNFV/index.rst
events/Summits/OpenDaylight/2016_02_29_fdioandhoneycomb.rst
events/Summits/OpenDaylight/2016_02_29_fdiointro.rst
events/Summits/OpenDaylight/index.rst
events/Summits/OpenNetworkSummit/2016_03_15_fdiofuture.rst
events/Summits/OpenNetworkSummit/2016_03_15_introfdio.rst
events/Summits/OpenNetworkSummit/2016_03_17_PacketProcess.rst
events/Summits/OpenNetworkSummit/index.rst
events/Summits/OpensourceSummit/2017_09_13_theuniversalnetworkdataplane.rst
events/Summits/OpensourceSummit/index.rst
events/Summits/UKNO/2017_04_30_buildingbespokesoftdataplane.rst
events/Summits/UKNO/index.rst
events/TLDKCall/2016_11_18_tcptimers.rst
events/TLDKCall/index.rst
events/VPPCall/2017_04_25_buildingincontainerspoc.rst
events/fdioTraining/2016_04_05_faster.rst
events/fdioTraining/AllTrainingContent/DayFour/4-1-mapinvpp.rst
events/fdioTraining/AllTrainingContent/DayFour/4-2-project-onelisp.rst
events/fdioTraining/AllTrainingContent/DayFour/4-3-csit-performancetesting.rst
events/fdioTraining/AllTrainingContent/DayFour/index.rst
events/fdioTraining/AllTrainingContent/DayOne/1-2-vppoverview.rst
events/fdioTraining/AllTrainingContent/DayOne/1-3-containerdemo.rst
events/fdioTraining/AllTrainingContent/DayOne/1-4-codecontributionmechanics.rst
events/fdioTraining/AllTrainingContent/DayOne/1-5-dpdkintroduction.rst
events/fdioTraining/AllTrainingContent/DayOne/index.rst
events/fdioTraining/AllTrainingContent/DayThree/2-4-more-macswap.rst
events/fdioTraining/AllTrainingContent/DayThree/3-1-buffer-metadata.rst
events/fdioTraining/AllTrainingContent/DayThree/3-2-multicorewalkthruanddpdkintegration.rst
events/fdioTraining/AllTrainingContent/DayThree/3-3-dpdkoptimizations.rst
events/fdioTraining/AllTrainingContent/DayThree/index.rst
events/fdioTraining/AllTrainingContent/DayThree/preworkandscripts.rst
events/fdioTraining/AllTrainingContent/DayThree/supplemental-graphwiringnotes.rst
events/fdioTraining/AllTrainingContent/DayTwo/2-1-dataplane-codeoverview.rst
events/fdioTraining/AllTrainingContent/DayTwo/2-2-vppinit.rst
events/fdioTraining/AllTrainingContent/DayTwo/2-3-eventlogger.rst
events/fdioTraining/AllTrainingContent/DayTwo/2-4-macswapbreakdown.rst
events/fdioTraining/AllTrainingContent/DayTwo/index.rst
events/fdioTraining/AllTrainingContent/DayTwo/preworkandscripts.rst
events/fdioTraining/AllTrainingContent/index.rst
events/fdioTraining/index.rst
events/index.rst
74030266 06-Aug-2018 andrew <andrew.olechtchouk@gmail.com>

DOC ONLY: Add a new doc for integrating a plugin with VPP

Convert doxygen docs (vpp api module and binary api support) to .rst

Added a brief explanation of binary api message numbering for plugins

Change-Id: If7d37f29aa65a884b51f3d27957f80d1357ed29b
Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
Signed-off-by: Dave Barach <dave@barachs.net>

bcddab22 06-Aug-2018 andrew <andrew.olechtchouk@gmail.com>

docs: Cleaned up a little removed instructions for mac.

docs: Updated section on using git-review

Change-Id: I180f67e3478b57b1de03df95fc67a0cfdd44dfb5
Signed-off-by: andrew <andrew.olechtchouk@gmail.com>

ec954310 07-Aug-2018 Dave Barach <dave@barachs.net>

DOC ONLY: document bihash table walker rules

Change-Id: I0c48e0f4b87065d8f42009e2cc9709c6b7f5e851
Signed-off-by: Dave Barach <dave@barachs.net>

c8e7f419 03-Aug-2018 John DeNisco <jdenisco@cisco.com>

Added missing file

docs: Incorporate Javier's progressive VPP tutorial

Change-Id: Iecee041039c7ed81713bc0530fc536e989c71497
Signed-off-by: John DeNisco <jdenisco@cisco.com>

c64ba6dc 02-Aug-2018 John DeNisco <jdenisco@cisco.com>

docs: Incororate Scott's overall review

Change-Id: Ic70a62e17891fa9291a5274400ae89f1d6194b6e
Signed-off-by: John DeNisco <jdenisco@cisco.com>

a14c1667 01-Aug-2018 John DeNisco <jdenisco@cisco.com>

docs: change code blocks from "shell" to "console"

Change-Id: I136fccfc06e07fb68d11df686c59687362fb8827
Signed-off-by: John DeNisco <jdenisco@cisco.com>

2d1a0437 26-Jul-2018 John DeNisco <jdenisco@cisco.com>

Fix .gitignore so docs/Makefile is not ignored. Add README and Makefile. Fis gitreview.

Change-Id: I3d664d9c881ce127a09b9d68c1181a7098a39074
Signed-off-by: John DeNisco <jdenisco@cisco.com>

06dcd45f 26-Jul-2018 John DeNisco <jdenisco@cisco.com>

Initial commit of Sphinx docs

Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77
Signed-off-by: John DeNisco <jdenisco@cisco.com>


README.rst
_images/Connecting_two_vpp_instances_with_memif.png
_images/Create_Interface_Topology.jpg
_images/ForkButtons.png
_images/SNAT_Topology.jpg
_images/Switching_Topology.jpg
_images/VNET_Features.png
_images/VPP_App_as_a_vSwitch_x201.jpg
_images/VPP_App_as_vSwitch_with_local_programmability_x260.jpg
_images/VPP_Layering.png
_images/VPP_Packet_Processing_Layer_In_Network_Stack_Overview.jpg
_images/VPP_and_ovsdpdk_tested_on_haswellx86_platform.jpg
_images/VPP_as_vSwitch_or_vRouter_supporting_remote_programmability_x260.jpg
_images/VPP_custom_application_packet_processing_graph.280.jpg
_images/VPP_performance_barchart_ndr_rates_l2-nic-to-VM.small.jpg
_images/VPP_sample_data_plane_management_agent_x260.jpg
_images/Vpp_performance_barchart_ndr_rates_l2-nic-to-nic.jpg
_images/authreadthedocs.png
_images/buildVerRTD.png
_images/createNewPullReq.png
_images/examplePullReq.png
_images/htmlBuild.png
_images/importRTDManually.png
_images/importReadDocs.png
_images/issuePullReq.png
_images/passedBuild.png
_images/rtdWebpage.png
_images/showBothRemotes.png
_images/showRemotes.png
_images/usernameFork.png
_images/vhost-topo.png
_static/css/rules.css
_static/fd-io_red_white.png
_static/fdio_logo.png
conf.py
etc/requirements.txt
events/CiscoLiveUS/2017_06_26_vppcontainernetwork.rst
events/CiscoLiveUS/index.rst
events/DPDKSummit/2016/2016_08_10_tldkintro.rst
events/DPDKSummit/2016/index.rst
events/DPDKSummit/2017/2017_11_15_dpdkvppandpfsense.rst
events/DPDKSummit/2017/2017_11_15_vpphoststack.rst
events/DPDKSummit/2017/index.rst
events/DPDKSummit/index.rst
events/FDIOVPPTerabit/2017_07_11_fdiouniversalterabitnetwork.rst
events/FDIOVPPTerabit/index.rst
events/FDioMiniSummit/KubeCon/2017_12_5_VPPHost.rst
events/FDioMiniSummit/KubeCon/2017_12_5_armrallying.rst
events/FDioMiniSummit/KubeCon/2017_12_5_benchmarking.rst
events/FDioMiniSummit/KubeCon/2017_12_5_empoweringuserspacestack.rst
events/FDioMiniSummit/KubeCon/index.rst
events/FDioMiniSummit/atOSS/2017_05_10_performanceconsideration.rst
events/FDioMiniSummit/atOSS/index.rst
events/FDioMiniSummit/index.rst
events/IntelSDN/2017_06_13_clearcontainers.rst
events/IntelSDN/2017_06_13_fdiooverview.rst
events/IntelSDN/index.rst
events/Linuxcon/2016_08_24_introfdio.rst
events/Linuxcon/2016_08_24_onelispintro.rst
events/Linuxcon/index.rst
events/OSCON/2017_05_11_40gbpsipsec.rst
events/OSCON/index.rst
events/OpNFV/OPNFVCSIT/2017_02_01_fdiocsitoverview.rst
events/OpNFV/OPNFVCSIT/index.rst
events/OpNFV/OPNFVSummit/2016_06_21_roadmap.rst
events/OpNFV/OPNFVSummit/2016_06_21_s1_introduction.rst
events/OpNFV/OPNFVSummit/2016_06_21_s2_nfvvirtualswitching.rst
events/OpNFV/OPNFVSummit/2016_06_21_s3_sdncontroller.rst
events/OpNFV/OPNFVSummit/2016_06_21_s4_dataplane.rst
events/OpNFV/OPNFVSummit/2016_06_21_s5_serviceassurance.rst
events/OpNFV/OPNFVSummit/index.rst
events/OpNFV/OpNFVtechnicalwork/2016_03_30_IntroFdio.rst
events/OpNFV/OpNFVtechnicalwork/index.rst
events/OpNFV/index.rst
events/OpenDaylight/2016_02_29_fdioandhoneycomb.rst
events/OpenDaylight/2016_02_29_fdiointro.rst
events/OpenDaylight/index.rst
events/OpenNetworkSummit/2016_03_15_fdiofuture.rst
events/OpenNetworkSummit/2016_03_15_introfdio.rst
events/OpenNetworkSummit/2016_03_17_PacketProcess.rst
events/OpenNetworkSummit/index.rst
events/OpensourceSummit/2017_09_13_theuniversalnetworkdataplane.rst
events/OpensourceSummit/index.rst
events/TLDKCall/2016_11_18_tcptimers.rst
events/TLDKCall/index.rst
events/TSCmeeting/2016_04_28_pariseventproposal.rst
events/TSCmeeting/index.rst
events/TWSMeeting/2016_08_30_introtodpdkcryptoandvpp.rst
events/TWSMeeting/index.rst
events/UKNO/2017_04_30_buildingbespokesoftdataplane.rst
events/UKNO/index.rst
events/VPPCall/2017_04_25_buildingincontainerspoc.rst
events/VPPCall/index.rst
events/fdioTraining/2016_04_05_faster.rst
events/fdioTraining/AllTrainingContent/DayFour/4-1-mapinvpp.rst
events/fdioTraining/AllTrainingContent/DayFour/4-2-project-onelisp.rst
events/fdioTraining/AllTrainingContent/DayFour/4-3-csit-performancetesting.rst
events/fdioTraining/AllTrainingContent/DayFour/index.rst
events/fdioTraining/AllTrainingContent/DayOne/1-2-vppoverview.rst
events/fdioTraining/AllTrainingContent/DayOne/1-3-containerdemo.rst
events/fdioTraining/AllTrainingContent/DayOne/1-4-codecontributionmechanics.rst
events/fdioTraining/AllTrainingContent/DayOne/1-5-dpdkintroduction.rst
events/fdioTraining/AllTrainingContent/DayOne/index.rst
events/fdioTraining/AllTrainingContent/DayThree/2-4-more-macswap.rst
events/fdioTraining/AllTrainingContent/DayThree/3-1-buffer-metadata.rst
events/fdioTraining/AllTrainingContent/DayThree/3-2-multicorewalkthruanddpdkintegration.rst
events/fdioTraining/AllTrainingContent/DayThree/3-3-dpdkoptimizations.rst
events/fdioTraining/AllTrainingContent/DayThree/index.rst
events/fdioTraining/AllTrainingContent/DayThree/preworkandscripts.rst
events/fdioTraining/AllTrainingContent/DayThree/supplemental-graphwiringnotes.rst
events/fdioTraining/AllTrainingContent/DayTwo/2-1-dataplane-codeoverview.rst
events/fdioTraining/AllTrainingContent/DayTwo/2-2-vppinit.rst
events/fdioTraining/AllTrainingContent/DayTwo/2-3-eventlogger.rst
events/fdioTraining/AllTrainingContent/DayTwo/2-4-macswapbreakdown.rst
events/fdioTraining/AllTrainingContent/DayTwo/index.rst
events/fdioTraining/AllTrainingContent/DayTwo/preworkandscripts.rst
events/fdioTraining/AllTrainingContent/index.rst
events/fdioTraining/index.rst
events/fdioWebinar/2016_05_25_softwaredataplanes.rst
events/fdioWebinar/index.rst
events/index.rst
gettingstarted/developers/bihash.md
gettingstarted/developers/building.rst
gettingstarted/developers/featurearcs.md
gettingstarted/developers/index.rst
gettingstarted/developers/infrastructure.md
gettingstarted/developers/plugins.md
gettingstarted/developers/softwarearchitecture.md
gettingstarted/developers/vlib.md
gettingstarted/developers/vnet.md
gettingstarted/index.rst
gettingstarted/users/configuring/hugepages.rst
gettingstarted/users/configuring/index.rst
gettingstarted/users/configuring/startup.rst
gettingstarted/users/configutil/commandfour.rst
gettingstarted/users/configutil/commandone.rst
gettingstarted/users/configutil/commandthree.rst
gettingstarted/users/configutil/commandtwo.rst
gettingstarted/users/configutil/configapplied.rst
gettingstarted/users/configutil/index.rst
gettingstarted/users/configutil/installing.rst
gettingstarted/users/configutil/sysinfo.rst
gettingstarted/users/configutil/usingvppconfig.rst
gettingstarted/users/index.rst
gettingstarted/users/installing/centos.rst
gettingstarted/users/installing/index.rst
gettingstarted/users/installing/opensuse.rst
gettingstarted/users/installing/packages.rst
gettingstarted/users/installing/ubuntu.rst
gettingstarted/users/running/index.rst
gettingstarted/writingdocs/buildingrst.rst
gettingstarted/writingdocs/gitreview.rst
gettingstarted/writingdocs/index.rst
gettingstarted/writingdocs/pushingapatch.rst
gettingstarted/writingdocs/readthedocs.rst
gettingstarted/writingdocs/styleguide/index.rst
gettingstarted/writingdocs/styleguide/iperf-vm.xml
gettingstarted/writingdocs/styleguide/rawhtml.rst
gettingstarted/writingdocs/styleguide/styleguide.rst
gettingstarted/writingdocs/styleguide/styleguide02.rst
gettingstarted/writingdocs/styleguide/styleguide02table.rst
gettingstarted/writingdocs/styleguide/styleguide03.rst
gettingstarted/writingdocs/styleguide/styleguide04.rst
gettingstarted/writingdocs/styleguide/styleguide05.rst
gettingstarted/writingdocs/styleguide/xmlexample.rst
gettingstarted/writingdocs/styleguidemd/index.rst
gettingstarted/writingdocs/styleguidemd/styleguide.md
gettingstarted/writingdocs/styleguidemd/styleguide02.md
gettingstarted/writingdocs/styleguidemd/styleguide03.md
gettingstarted/writingdocs/todo.rst
guides/api/index.rst
guides/api/jvpp.rst
guides/index.rst
guides/progressivevpp/index.rst
guides/progressivevpp/vagrant.rst
index.rst
overview/features/controlplane.rst
overview/features/devices.rst
overview/features/index.rst
overview/features/integrations.rst
overview/features/l2.rst
overview/features/l3.rst
overview/features/l4.rst
overview/features/plugins.rst
overview/features/trafficmanagement.rst
overview/features/tunnels.rst
overview/index.rst
overview/performance/current_ipv4_throughput.rst
overview/performance/current_ipv6_throughput.rst
overview/performance/current_l2_throughput.rst
overview/performance/current_ndr_throughput.rst
overview/performance/index.rst
overview/performance/trending_ipv4_throughput.rst
overview/performance/trending_ipv6_throughput.rst
overview/performance/trending_l2_throughput.rst
overview/supported.rst
overview/whatisvpp/dataplane.rst
overview/whatisvpp/developer.rst
overview/whatisvpp/extensible.rst
overview/whatisvpp/fast.rst
overview/whatisvpp/index.rst
overview/whatisvpp/what-is-vector-packet-processing.rst
reference/cmdreference/index.rst
reference/cmdreference/interface/hardware.rst
reference/cmdreference/interface/index.rst
reference/cmdreference/interface/interface.rst
reference/cmdreference/interface/subinterface.rst
reference/cmdreference/vhost/index.rst
reference/cmdreference/vhost/vhostuser.rst
reference/index.rst
reference/vppvagrant/VagrantVMSetup.rst
reference/vppvagrant/Vagrantfile
reference/vppvagrant/boxSetup.rst
reference/vppvagrant/index.rst
reference/vppvagrant/installingVboxVagrant.rst
reference/vppvagrant/settingENV.rst
reference/vppvagrant/vagrantOverview.rst
reference/vppvagrant/vppVagrantfile.rst
troubleshooting/cpuusage.rst
troubleshooting/index.rst
troubleshooting/reportingissues/index.rst
troubleshooting/reportingissues/reportingissues.rst
usecases/Routing.rst
usecases/containerCreation.rst
usecases/containerSetup.rst
usecases/containers.rst
usecases/homegateway.rst
usecases/index.rst
usecases/uc_vSwitchvRouter.rst
usecases/vhost/index.rst
usecases/vhost/iperf-vm.xml
usecases/vhost/vhost.rst
usecases/vhost/vhost02.rst
usecases/vhost/vhost03.rst
usecases/vhost/vhost04.rst
usecases/vhost/vhost05.rst
usecases/vhost/xmlexample.rst
bf2f3261 11-Jul-2018 Ed Kern <ejk@cisco.com>

Documentation: Placeholder directory and files

This adds the directory sphinx and sphinx/docs
as well as two matching placeholder files. These
are being added now to facilitate some gerrit triggers

Change-Id: I0e6e7607c5ae5cdbf05718b95b1d299178544485
Signed-off-by: Ed Kern <ejk@cisco.com>