ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
vpp/.gitignore

87 lines
1.2 KiB
Plaintext
Raw Normal View History

Initial commit of vpp code. Change-Id: Ib246f1fbfce93274020ee93ce461e3d8bd8b9f17 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2015-12-08 15:45:58 -07:00
*~
VPP-221 CLI auto-documentation infrastructure 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: I80d6fe349b47dce649fa77d21ffec0ddb45c7bbf Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-07-25 16:38:11 -04:00
*.sw[op]
HONEYCOMB-10: jVpp - the new java API. C code and jar file generation 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-26 12:09:05 +02:00
Initial commit of vpp code. Change-Id: Ib246f1fbfce93274020ee93ce461e3d8bd8b9f17 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2015-12-08 15:45:58 -07:00
/build-root/.ccache
/build-root/build-*/
/build-root/install-*/
/build-root/tools
Add a vpp-dpdk-dev package, enable plugins to use dpdk APIs directly Change-Id: I69db06a0b5d5d556c2fd570ea0056bb59d7bc3d6 Signed-off-by: Dave Barach <dave@barachs.net>
2016-02-01 12:05:52 -05:00
/build-root/dpdk-includes/
Initial commit of vpp code. Change-Id: Ib246f1fbfce93274020ee93ce461e3d8bd8b9f17 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2015-12-08 15:45:58 -07:00
/build-root/packages-vpp/
/build-root/path_setup
/build-root/build-config.mk
Updating gitignore for generated plugins folder Change-Id: I266db9f4667c4f720d6109fad5c4d31eb182ed30 Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-07-21 06:12:13 -07:00
/build-root/deb/debian/vpp-plugins/
Initial commit of vpp code. Change-Id: Ib246f1fbfce93274020ee93ce461e3d8bd8b9f17 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2015-12-08 15:45:58 -07:00
/build-root/*.deb
Add build-root/*.rpm to .gitignore Change-Id: I88398b5e538271efa4657851bf53c9b76a56b432 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2016-03-22 16:09:29 -05:00
/build-root/*.rpm
Initial commit of vpp code. Change-Id: Ib246f1fbfce93274020ee93ce461e3d8bd8b9f17 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2015-12-08 15:45:58 -07:00
/build-root/*.changes
add vpp debugging support to test framework improve test documentation Change-Id: Ia9678aa2532ecb4cb33736aedb4a31aa3f2a3f93 Signed-off-by: Klement Sekera <ksekera@cisco.com>
2016-10-28 13:20:27 +02:00
/build-root/test-doc/
fix typo in .gitignore Change-Id: I09c25b855c09f55da7e836e641570befead40f4f Signed-off-by: Klement Sekera <ksekera@cisco.com>
2016-11-01 12:33:40 +01:00
/build-root/python/
Initial commit of vpp code. Change-Id: Ib246f1fbfce93274020ee93ce461e3d8bd8b9f17 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2015-12-08 15:45:58 -07:00
/build-config.mk
/dpdk/*.tar.gz
gitignore change due to DPDK download suffix change Change-Id: Idc86d3435e742f3cb96cb9eb1d85b0fdc6a40fc5 Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-06-14 09:10:53 -07:00
/dpdk/*.tar.xz
Initial commit of vpp code. Change-Id: Ib246f1fbfce93274020ee93ce461e3d8bd8b9f17 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2015-12-08 15:45:58 -07:00
/path_setup
/tools/
Update .gitignore to ignore autotools files Change-Id: I01bb50304dec7461335800916a76e311701ab8c5 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2015-12-15 18:28:50 -07:00
# start autotools ignore
autom4te.cache/
config/
Makefile
Makefile.in
aclocal.m4
app.info
compile
config.h
config.h.in
config.log
config.guess
config.sub
config.status
configure
configure.scan
coverage_report
depcomp
install-sh
libtool
m4
missing
stamp-h1
ltmain.sh
ylwrap is also autotools autogenerated file Change-Id: Ia6f26b5a12c2fb7847f9325519a99cf928263374 Signed-off-by: Damjan Marion <damarion@cisco.com>
2015-12-23 12:23:54 +01:00
ylwrap
Add unit test infrastructure for LISP protocol Change-Id: I802700ad832de1dc6f4a1981e8985aa6e926c8ad Signed-off-by: Filip Tehlar <ftehlar@cisco.com>
2016-04-07 10:04:34 +02:00
test-driver
gitignore Change-Id: I59c4711fce1999b4bd23f0a0bac41aa14ca716f5 Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
2016-02-24 11:30:00 +01:00
.cproject
*.iml
.bootstrap.ok
.settings
Update .gitignore to ignore autotools files Change-Id: I01bb50304dec7461335800916a76e311701ab8c5 Signed-off-by: Ed Warnicke <eaw@cisco.com>
2015-12-15 18:28:50 -07:00
# stop autotools ignore
Git ignore additions Change-Id: Iabf569e96d3a1ab50d737913ed997264a69762cc Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-01-31 20:38:54 +01:00
VPP Python language binding - plugin support - Moved Python generator tool to tools directory - Added build-vpp-api Makefile target - Generator now only creates a Python representation of the .api the rest of the framework is in the vpp_papi script - Each plugin has its own namespace. - Plugin Python files are installed in vpp_papi_plugins for easy use inside the build tree. Change-Id: I272c83bb7e5d5e416bdbd8a790a3cc35c5a04e38 Signed-off-by: Ole Troan <ot@cisco.com>
2016-08-01 04:59:13 +02:00
# OSX and some IDE
Git ignore additions Change-Id: Iabf569e96d3a1ab50d737913ed997264a69762cc Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-01-31 20:38:54 +01:00
.DS_Store
.idea/
.project
add ctags and cscope files to .gitignore Change-Id: I047cc41a5d0c4a6e4191ca35c505ff21236abcfa Signed-off-by: Damjan Marion <damarion@cisco.com>
2016-03-17 17:53:03 +01:00
# cscope and ctags
/cscope.*
/tags
A Protocol Independent Hierarchical FIB (VPP-352) Main Enhancements: - Protocol Independent FIB API - Hierarchical FIB entries. Dynamic recursive route resolution. - Extranet Support. - Integration of IP and MPLS forwarding. - Separation of FIB and Adjacency databases. - Data-Plane Object forwarding model. Change-Id: I52dc815c0d0aa8b493e3cf6b978568f3cc82296c Signed-off-by: Neale Ranns <nranns@cisco.com>
2016-08-25 15:29:12 +01:00
ID
TAGS
gitignore gtags Change-Id: I0160cdfc8e749f875a232e07526d53a3a7c8395c Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-06-18 12:21:41 -07:00
# ggtags
GPATH
GRTAGS
GTAGS
VPP-57 Add Doxygen to VPP - 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-03 16:34:59 -04:00
# Generated documentation
/build-root/docs
VPP-221 CLI auto-documentation infrastructure 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: I80d6fe349b47dce649fa77d21ffec0ddb45c7bbf Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-07-25 16:38:11 -04:00
/build-root/.doxygen-bootstrap.ok
/build-root/.doxygen-siphon.dep
VPP-237: Checkstyle script to check for new checkstyle breakage 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-08-05 11:43:58 -07:00
# indent backup files
*.BAK
Create python package for jvpp generation. Change-Id: I2254f90b2c3e423563bb91bf70877979f1e86a6b Signed-off-by: Ed Warnicke <eaw@cisco.com> Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
2016-07-11 10:29:41 -07:00
# Python bytecode
*.pyc
VPP-364 Add vpp-api/python/build to gitignore Change-Id: I16a594ad75c085b8d0b74cf2f472f88a655253c0 Signed-off-by: Florin Coras <fcoras@cisco.com>
2016-08-30 11:46:11 +02:00
Add generated python bindings to .gitignore Change-Id: I05b5955afa9fee5dd213a98126982626eae4d9ca Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
2016-10-25 12:17:33 +02:00
# Python api generator
VPP-364 Add vpp-api/python/build to gitignore Change-Id: I16a594ad75c085b8d0b74cf2f472f88a655253c0 Signed-off-by: Florin Coras <fcoras@cisco.com>
2016-08-30 11:46:11 +02:00
/vpp-api/python/build
Add generated python bindings to .gitignore Change-Id: I05b5955afa9fee5dd213a98126982626eae4d9ca Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
2016-10-25 12:17:33 +02:00
/vpp-api/python/dist
/vpp-api/python/vpp_papi.egg-info
/vpp-api/python/vpp_papi/memclnt.py
/vpp-api/python/vpp_papi/vpe.py
Reference in New Issue Copy Permalink