Add ref to test framework docs in doxygen output.
Change-Id: If3081c4a9dde00cd522d1fc5a7daa9b1849684bf Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
This commit is contained in:
Dave Wallace
committed by
Dave Barach
parent
2d41f169c8
commit
c8c5335e3a
@ -30,7 +30,6 @@ Directory name | Description
|
||||
build-root | Build output directory
|
||||
doxygen | Documentation generator configuration
|
||||
dpdk | DPDK patches and build infrastructure
|
||||
@ref plugins | Not-yet-relocated VPP bundled plugins directory
|
||||
@ref src | VPP source code
|
||||
@ref src/plugins | VPP bundled plugins directory
|
||||
@ref src/svm | Shared virtual memory allocation library
|
||||
@ -45,7 +44,7 @@ Directory name | Description
|
||||
@ref src/vpp-api | VPP application API bindings
|
||||
@ref src/vppinfra | VPP core library
|
||||
test | Unit tests
|
||||
@ref vpp-api | Not-yet-relocated API bindings
|
||||
@ref src/vpp/api | Not-yet-relocated API bindings
|
||||
|
||||
|
||||
## Getting started
|
||||
@ -100,3 +99,8 @@ information.
|
||||
|
||||
Visit the [VPP wiki](https://wiki.fd.io/view/VPP) for details on more
|
||||
advanced building strategies and development notes.
|
||||
|
||||
|
||||
## Test Framework
|
||||
|
||||
There is PyDoc generated documentation available for the VPP test framework. See @subpage test_framework_doc for details.
|
||||
|
@ -82,10 +82,6 @@ DOXY_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(DOXY_EXCLUDE))' | se
|
||||
# Include all the normal source directories in the include file path
|
||||
DOXY_INCLUDE_PATH = $(DOXY_SRC_DIRECTORIES)
|
||||
|
||||
# Also include any plugin directories that exist
|
||||
DOXY_INCLUDE_PATH += \
|
||||
$(shell find $(WS_ROOT)/plugins -maxdepth 1 -type d | sed -e 's@^$(WS_ROOT)/*@@')
|
||||
|
||||
# Find API header directories and include them in the header path.
|
||||
# This is only useful if VPP and plugins are already built; nothing
|
||||
# here depends on those targets. We don't build documentation for these
|
||||
@ -140,7 +136,7 @@ ifeq ($(OS_ID),ubuntu)
|
||||
sudo apt-get $(CONFIRM) $(FORCE) install $$inst; \
|
||||
fi
|
||||
@if [ ! -s /usr/lib/graphviz/config6a ]; then \
|
||||
echo "Rebuidlding system Graphviz configuration."; \
|
||||
echo "Rebuilding system Graphviz configuration."; \
|
||||
sudo dot -c; \
|
||||
fi
|
||||
else ifneq ("$(wildcard /etc/redhat-release)","")
|
||||
|
7
doxygen/test_framework_doc.md
Normal file
7
doxygen/test_framework_doc.md
Normal file
@ -0,0 +1,7 @@
|
||||
Test Framework Documentation {#test_framework_doc}
|
||||
============================
|
||||
|
||||
PyDoc generated documentation for the "make test" framework is available for the following releases
|
||||
|
||||
- [Test framework documentation for VPP 17.04](https://docs.fd.io/vpp/17.04/vpp_make_test/html)
|
||||
- [Test framework documentation for VPP 17.01](https://docs.fd.io/vpp/17.01/vpp_make_test/html)
|
Reference in New Issue
Block a user