54ccf2261c
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>
80 lines
1012 B
Plaintext
80 lines
1012 B
Plaintext
*~
|
|
*.sw[op]
|
|
|
|
/build-root/.ccache
|
|
/build-root/build-*/
|
|
/build-root/install-*/
|
|
/build-root/tools
|
|
/build-root/dpdk-includes/
|
|
/build-root/packages-vpp/
|
|
/build-root/path_setup
|
|
/build-root/build-config.mk
|
|
/build-root/deb/debian/vpp-plugins/
|
|
/build-root/*.deb
|
|
/build-root/*.rpm
|
|
/build-root/*.changes
|
|
/build-config.mk
|
|
/dpdk/*.tar.gz
|
|
/dpdk/*.tar.xz
|
|
/path_setup
|
|
/tools/
|
|
# 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
|
|
test-driver
|
|
|
|
.cproject
|
|
*.iml
|
|
.bootstrap.ok
|
|
.settings
|
|
# stop autotools ignore
|
|
|
|
# OSX and some IDE
|
|
.DS_Store
|
|
.idea/
|
|
.project
|
|
|
|
# cscope and ctags
|
|
/cscope.*
|
|
/tags
|
|
# ggtags
|
|
GPATH
|
|
GRTAGS
|
|
GTAGS
|
|
TAGS
|
|
|
|
# Generated documentation
|
|
/build-root/docs
|
|
/build-root/.doxygen-bootstrap.ok
|
|
/build-root/.doxygen-siphon.dep
|
|
|
|
# indent backup files
|
|
*.BAK
|
|
|
|
# Python bytecode
|
|
*.pyc
|
|
|
|
/vpp-api/python/build
|