summaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/developers/infrastructure.md
diff options
context:
space:
mode:
authorDave Wallace <dwallacelf@gmail.com>2018-12-13 12:29:44 -0500
committerFlorin Coras <florin.coras@gmail.com>2018-12-17 00:10:16 +0000
commit4659d0e82343e6c061261f0a2aa977b0d00f199d (patch)
tree2bb24ef2b0bf23e08537211743e71ac53dc361f6 /docs/gettingstarted/developers/infrastructure.md
parent4ee633e84af18e9237554df2015a332749dc358a (diff)
docs: clarify vector element alignment description.
Change-Id: I6da153779010263e6fc4b51c64b01444aaadca17 Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
Diffstat (limited to 'docs/gettingstarted/developers/infrastructure.md')
-rw-r--r--docs/gettingstarted/developers/infrastructure.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/gettingstarted/developers/infrastructure.md b/docs/gettingstarted/developers/infrastructure.md
index 0361a632c37..b99460732c5 100644
--- a/docs/gettingstarted/developers/infrastructure.md
+++ b/docs/gettingstarted/developers/infrastructure.md
@@ -48,13 +48,16 @@ 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 data elements via the [vec]()\*\_aligned macros.
+alignment for first data element of a vector via the [vec]()\*\_aligned
+macros.
-Vectors elements can be any C type e.g. (int, double, struct bar). This
+Vector elements can be any C type e.g. (int, double, struct bar). This
is also true for data types built atop vectors (e.g. heap, pool, etc.).
-Many macros have \_a variants supporting alignment of vector data and
-\_h variants supporting non-zero-length vector headers. The \_ha
-variants support both.
+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.
Inconsistent usage of header and/or alignment related macro variants
will cause delayed, confusing failures.