diff mbox

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

Message ID 1446037401-20990-2-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit 1013035b34a3d3548b90159413fcd92ff1846bdd
Headers show

Commit Message

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

Patch

diff --git a/include/odp/api/config.h b/include/odp/api/config.h
index ed27ed5..a838416 100644
--- a/include/odp/api/config.h
+++ b/include/odp/api/config.h
@@ -20,6 +20,14 @@  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. Applications SHOULD expect that over time such
+ * \#defines will be deprecated and removed.
  *  @{
  */