diff options
| author |   jdenisco <jdenisco@cisco.com> | 2019-05-13 12:40:21 -0400 |
|---|---|---|
| committer |   Dave Barach <openvpp@barachs.net> | 2019-05-16 17:42:13 +0000 |
| commit | 8a6e1b190c63cc596aed33f84b5989b64d276423 (patch) | |
| tree | 016c181103861da2791c090a3b874b9bc385234e /docs/gettingstarted | |
| parent | 8fa01c17aa65c03b1f25f9accaa5bb0f9d0862c4 (diff) | |
docs: Update sphinx, requirements, support markdown tables
Change-Id: Ie7c546f5720b10fe5423397204e1ab5c22d7a2ba
Signed-off-by: jdenisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/gettingstarted')
| -rw-r--r-- | docs/gettingstarted/developers/infrastructure.md | 4 | ||||
| -rw-r--r-- | docs/gettingstarted/writingdocs/styleguidemd/styleguide03.md | 10 |
2 files changed, 12 insertions, 2 deletions
diff --git a/docs/gettingstarted/developers/infrastructure.md b/docs/gettingstarted/developers/infrastructure.md index b99460732c5..9dde9829906 100644 --- a/docs/gettingstarted/developers/infrastructure.md +++ b/docs/gettingstarted/developers/infrastructure.md @@ -48,7 +48,7 @@ macro! It's smart about NULL pointers.\] Typically, the user header is not present. User headers allow for other data structures to be built atop vppinfra vectors. Users may specify the -alignment for first data element of a vector via the [vec]()\*\_aligned +alignment for first data element of a vector via the \[vec\]()\*\_aligned macros. Vector elements can be any C type e.g. (int, double, struct bar). This @@ -57,7 +57,7 @@ Many macros have \_a variants supporting alignment of vector elements and \_h variants supporting non-zero-length vector headers. The \_ha variants support both. Additionally cacheline alignment within a vector element structure can be specified using the -[CLIB_CACHE_LINE_ALIGN_MARK]() macro. +\[CLIB_CACHE_LINE_ALIGN_MARK\]() macro. Inconsistent usage of header and/or alignment related macro variants will cause delayed, confusing failures. diff --git a/docs/gettingstarted/writingdocs/styleguidemd/styleguide03.md b/docs/gettingstarted/writingdocs/styleguidemd/styleguide03.md index 462006fd6f3..4c66dc4de33 100644 --- a/docs/gettingstarted/writingdocs/styleguidemd/styleguide03.md +++ b/docs/gettingstarted/writingdocs/styleguidemd/styleguide03.md @@ -20,3 +20,13 @@ referenced with following construct. This is the image created to show a pull request.  + +Tables +====== + +An example of a table in markdown is shown here: + +| This Column | This Column | This Column | +| ------------|:-------------:|------------:| +| is left | is | is right | +| aligned | centered | aligned | |