summaryrefslogtreecommitdiffstats
path: root/doxygen/Makefile
AgeCommit message (Collapse)AuthorFilesLines
2016-09-1416.09 Release Notes - VPP-135Keith Burns (alagalah)1-0/+1
Change-Id: I9a2ae5dc859e73682003175a8987d49bf0729d02 Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-09-14Add structure to some of the documentation; VPP-223Chris Luke1-0/+1
Moves the random .md files into a config examples tree Change-Id: If423b82f1047f1c84f90876a786313054b5f7c77 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-09Check for zero-sized Graphvix config file on Ubuntu; VPP-396Chris Luke1-1/+2
- The previous change only accounted for a missing Graphviz config file; apparently it can be zero-sized too. Change-Id: Ic6957d10cdc7cb7b9da72d2b2a0f8913100870c5 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-09On Ubuntu check for graphviz system config; VPP-396Chris Luke1-0/+3
- Sometimes it seems Ubuntu doesn't always set up the Graphviz handler config. If it's missing, generate it. https://bugs.launchpad.net/ubuntu/+source/graphviz/+bug/1349026 Change-Id: I2c1e566817de8415f8b360c6f967cd76307a2a52 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-07VPP-221 CLI auto-documentation infrastructureChris Luke1-0/+154
[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>