summaryrefslogtreecommitdiffstats
path: root/.gitignore
AgeCommit message (Collapse)AuthorFilesLines
2016-09-07VPP-221 CLI auto-documentation infrastructureChris Luke1-0/+3
[Note: This is an amalgamation of several patches cherry-picked from master all related to introducing auto-CLI documentation. See commits d4024f58 ee4743ad 16bcf7d8 e0d802bc 54ccf226] As a step before Doxygen, extract CLI-related struct initializers from the code and parse that into a summary of the CLI commands available with the provided help text, such as it is. At the moment this only renders this into an indexed Markdown file that Doxygen then picks up but later we can use this information to enrich the existing VLIB_CLI_COMMAND macro documentor as well as provide runtime documentation to VPP that is stored on disk outside the binary image. Additionally support a comment block immediately prior to VLIB_CLI_COMMAND CLI command definitions in the form /*? ... ?*/ that can be used to include long-form documentation without having it compiled into VPP. Examples of documenting CLI commands can be found in vlib/vlib/unix/cli.c which, whilst not perfect, should provide a starting point. Screen captures of sample output can be seen at https://chrisy.flirble.org/vpp/doxy-cli-example.png and https://chrisy.flirble.org/vpp/doxy-cli-index.png . Next, shift the Doxygen root makefile targets to their own Makefile. The primary reason for this is that the siphon targets do dependency tracking which means it needs to generate those dependencies whenever make is run; that is pointless if we're not going to generate any documentation. This includes the package dependencies since they since they sometimes unnecessarily interfere with the code build in some cases at the moment; later we will look to building a Python venv to host the Python modules we use. One final remark: In future we may consider deprecating .long_help in the VLIB_CLI_COMMAND structure entirely but add perhaps .usage_help. .short_help would be reserved for a summary of the command function and .usage_help provide the syntax of that command. These changes would provide great semantic value to the automaticly generated CLI documentation. I could also see having .long_help replaced by a mechanism that reads it from disk at runtime with a rudimentary Markdown/Doxygen filter so that we can use the same text that is used in the published documentation. Change-Id: I8afccfd7fe2096411d8064ac954ca5a2cbca9ae7 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-08-16Create python package for jvpp generation.Ed Warnicke1-0/+3
Change-Id: I2254f90b2c3e423563bb91bf70877979f1e86a6b Signed-off-by: Ed Warnicke <eaw@cisco.com> Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
2016-08-12VPP-237: Checkstyle script to check for new checkstyle breakageEd Warnicke1-0/+3
indent is... cantankerous It sometimes happens that if you run indent A resulting in A' and then indent A' you get back A. Since the check here is premised on being able to run indent and not see any changed... we have to run it twice to be sure. Change-Id: I5b73e02f5996d8a01ec2e46741affbc6d62da6c9 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2016-07-21Updating gitignore for generated plugins folderKeith Burns (alagalah)1-0/+1
Change-Id: I266db9f4667c4f720d6109fad5c4d31eb182ed30 Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-06-19gitignore gtagsKeith Burns (alagalah)1-0/+4
Change-Id: I0160cdfc8e749f875a232e07526d53a3a7c8395c Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-06-14gitignore change due to DPDK download suffix changeKeith Burns (alagalah)1-0/+1
Change-Id: Idc86d3435e742f3cb96cb9eb1d85b0fdc6a40fc5 Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-05-13VPP-57 Add Doxygen to VPPChris Luke1-0/+3
- Configures Doxygen. - Adds a source filter to do magic on our use of the preprocessor to do constructor stuff to make Doxygen grok it better. - Adds a convenience helper to the root Makefile. - Adds a README.md to the root directory (and which Doxygem uses as its "mainpage". - Add several other documentative files. - Currently using SVG for call graphs, though this may have a load-time performance impact in browsers. Change-Id: I25fc6fb5bf634319dcb36a7f0e32031921c125ac Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-05-12Generate jvpp sources in build-rootMaros Marsalek1-5/+0
+ Fail build when JVpp does not compile Change-Id: I4ad3ffb5d7ff6edaad89de66a9f0bd79a14fb690 Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
2016-05-02HONEYCOMB-10: jVpp - the new java API. C code and jar file generationMarek Gradzki1-0/+6
Added comments generation for C and Java files. Change-Id: Ifb670a5592eb871bfe68804f0a8d8f9b5b14f00a Signed-off-by: Marek Gradzki <mgradzki@cisco.com> Signed-off-by: Ed Warnicke <eaw@cisco.com>
2016-04-24Updated .gitignore for Python API generated fileKeith Burns (alagalah)1-0/+1
Change-Id: I7c08b52124b44feb36e04a7fd417fe14b367cb44 Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-04-12Add unit test infrastructure for LISP protocolFilip Tehlar1-0/+1
Change-Id: I802700ad832de1dc6f4a1981e8985aa6e926c8ad Signed-off-by: Filip Tehlar <ftehlar@cisco.com>
2016-03-25Add build-root/*.rpm to .gitignoreEd Warnicke1-0/+1
Change-Id: I88398b5e538271efa4657851bf53c9b76a56b432 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2016-03-18add ctags and cscope files to .gitignoreDamjan Marion1-0/+4
Change-Id: I047cc41a5d0c4a6e4191ca35c505ff21236abcfa Signed-off-by: Damjan Marion <damarion@cisco.com>
2016-03-04gitignoreMaros Marsalek1-0/+5
Change-Id: I59c4711fce1999b4bd23f0a0bac41aa14ca716f5 Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
2016-02-01Add a vpp-dpdk-dev package, enable plugins to use dpdk APIs directlyDave Barach1-0/+1
Change-Id: I69db06a0b5d5d556c2fd570ea0056bb59d7bc3d6 Signed-off-by: Dave Barach <dave@barachs.net>
2016-01-31Git ignore additionsKeith Burns (alagalah)1-0/+5
Change-Id: Iabf569e96d3a1ab50d737913ed997264a69762cc Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2015-12-23ylwrap is also autotools autogenerated fileDamjan Marion1-0/+1
Change-Id: Ia6f26b5a12c2fb7847f9325519a99cf928263374 Signed-off-by: Damjan Marion <damarion@cisco.com>
2015-12-16Update .gitignore to ignore autotools filesEd Warnicke1-1/+25
Change-Id: I01bb50304dec7461335800916a76e311701ab8c5 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2015-12-08Initial commit of vpp code.v1.0.0Ed Warnicke1-0/+15
Change-Id: Ib246f1fbfce93274020ee93ce461e3d8bd8b9f17 Signed-off-by: Ed Warnicke <eaw@cisco.com>