32 Commits

Author SHA1 Message Date
Dave Barach
f9faf2420c 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>
2018-10-05 13:48:00 +00:00
Scott Keeler
25c4d396ea docs: add contiv vpp
Change-Id: I92227fc4968fc6a478beb7f38707b91e9f0635ec
Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-10-05 13:47:42 +00:00
jdenisco
3138d72309 Add the sphinx docs build options
Change-Id: If7ac5b41ca4ac602a100b616b37d07f658fd6a90
Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-09-24 21:37:00 +00:00
jdenisco
45e1cd92ca docs: Added Related Projects and Archive
Change-Id: I9a6076aa53d810ec44761d9f9459eb91f2c05974
Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-09-18 21:03:06 +00:00
Damjan Marion
79dcbc74cd 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>
2018-09-12 16:38:59 +00:00
Scott Keeler
d9668e7153 docs: what is vpp and features and performance
Change-Id: I5a9ae39ed0429b3de001b5109268d577a281cd46
Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-09-07 07:29:27 +00:00
Dave Barach
ecbe6f5eb9 DOC ONLY: cmake / ninja build system doc
Change-Id: I69cdcf3f0940f8a5f60203034688a0c63446f65c
Signed-off-by: Dave Barach <dave@barachs.net>
2018-09-06 14:40:51 +00:00
Neale Ranns
75c276f9e3 Docs: update MPLS FIB section with text from the wiki
Change-Id: I9d903db89facc916fb5dd23d564417230e1c76e0
Signed-off-by: Neale Ranns <nranns@cisco.com>
2018-08-31 12:45:48 +00:00
Scitt Keeler
d9b2fcebef docs: Add features by release section
Change-Id: Ibcae8c8ecdf8a3c2d7bcf96bf7cd5b741e2fad22
Signed-off-by: Scitt Keeler <skeeler@cisco.com>
2018-08-30 18:45:51 +00:00
jdenisco
0923a2376f docs: FIB 2.0 start
Change-Id: I87cd2eae133c9f5b9f7764a0f7a41bcc28523e4c
Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-08-30 15:14:49 +00:00
John DeNisco
2ba9dcf408 docs: Finish event logger, viewer and cleanup.
Change-Id: I3de038439bf0ab5755777c0f4930aec0514f5b63
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-27 14:18:25 +00:00
John DeNisco
a5db42f366 docs: Moved installing up a level, removed guides.
Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-17 19:40:10 +00:00
Lijian Zhang
4af47b89c6 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>
2018-08-17 17:30:09 +00:00
John DeNisco
c4c72d2835 docs: Rework the VPP progressive Tutorial.
Change-Id: If5b0d07ea90d978c6b1f11210a661876b7929653
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-17 17:28:28 +00:00
John DeNisco
ce96dda447 DOCS: Moved multiarch and build system, Incorprated Scott's changes
Change-Id: I5a57846db2d4faac1aa24db4629b612657f59afb
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-14 20:13:21 +00:00
andrew
9f0c02053f DOCS: Updated startup.conf parameters
Change-Id: Id1f4ff7409e8a833b8f7e6030d7287d8c1274c2d
Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
2018-08-14 20:12:46 +00:00
John DeNisco
758dc46072 DOCS: Cleanup Getting Started
Change-Id: I4766773779f8d5c30a24bfed48090d7305c80ec5
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-13 17:00:22 -04:00
Dave Barach
f46663c65b DOC-ONLY: document latest multi-arch support scheme
Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I613415c109f648248ee04dd76d5e652dbf21bc7f
2018-08-10 11:15:55 -04:00
Dave Barach
8e83bcb9ae 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>
2018-08-10 15:05:09 +00:00
andrew
a38d001cfe 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>
2018-08-10 15:04:46 +00:00
andrew
df50b45e23 DOCS: General cleanup (did not move any sections)
Change-Id: I67cc42769661c10d2793f8c6cdb3b232b803d145
Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
2018-08-09 18:03:05 +00:00
javierfernandezvalles
7d84c16eb6 DOCS: modified writing docs section
Change-Id: Ic3ec16dba1a6374785f25f622b2cdc9b6415a13b
Signed-off-by: javierfernandezvalles <JaviervallesF@gmail.com>
2018-08-09 18:02:42 +00:00
John DeNisco
faa9300867 DOCS: Restructure Events
Change-Id: I135ced20b58cdb72fbd0784015af037bb6e7ad28
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-09 18:02:20 +00:00
andrew
740302661b 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>
2018-08-08 11:42:00 +00:00
andrew
bcddab220f 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>
2018-08-07 20:50:30 +00:00
Dave Barach
ec954310e3 DOC ONLY: document bihash table walker rules
Change-Id: I0c48e0f4b87065d8f42009e2cc9709c6b7f5e851
Signed-off-by: Dave Barach <dave@barachs.net>
2018-08-07 15:27:22 -04:00
John DeNisco
c8e7f419fe Added missing file
docs: Incorporate Javier's progressive VPP tutorial

Change-Id: Iecee041039c7ed81713bc0530fc536e989c71497
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-03 17:38:40 +00:00
John DeNisco
c64ba6dc6a docs: Incororate Scott's overall review
Change-Id: Ic70a62e17891fa9291a5274400ae89f1d6194b6e
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-03 09:07:18 +00:00
John DeNisco
a14c166740 docs: change code blocks from "shell" to "console"
Change-Id: I136fccfc06e07fb68d11df686c59687362fb8827
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-01 20:21:23 +00:00
John DeNisco
2d1a04371a 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>
2018-07-27 00:13:36 +00:00
John DeNisco
06dcd45ff8 Initial commit of Sphinx docs
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26 18:34:47 +00:00
Ed Kern
bf2f3261b2 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>
2018-07-11 18:10:04 +00:00