diff mbox

[API-NEXT,PATCHv2,2/2] api: config: add usage note about defines

Message ID 1445964131-27881-2-git-send-email-bill.fischofer@linaro.org
State Superseded
Headers show

Commit Message

Bill Fischofer Oct. 27, 2015, 4:42 p.m. UTC
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 include/odp/api/config.h | 7 +++++++
 1 file changed, 7 insertions(+)
diff mbox

Patch

diff --git a/include/odp/api/config.h b/include/odp/api/config.h
index ed27ed5..f35f951 100644
--- a/include/odp/api/config.h
+++ b/include/odp/api/config.h
@@ -20,6 +20,13 @@  extern "C" {
 
 /** @defgroup odp_config ODP CONFIG
  *  Platform-specific configuration limits.
+ *
+ * @note The API calls defined for ODP configuration limits are the
+ * normative means of accessing platform-specific configuration limits.
+ * Platforms MAY in addition include \#defines for these limits for
+ * internal use in dimensioning arrays, however there is no guarantee
+ * that applications using such \#defines will be portable across all
+ * ODP implementations.
  *  @{
  */