aboutsummaryrefslogtreecommitdiff
path: root/include/odp/api/init.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/odp/api/init.h')
-rw-r--r--include/odp/api/init.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/odp/api/init.h b/include/odp/api/init.h
index 737ff6d69..4ac521671 100644
--- a/include/odp/api/init.h
+++ b/include/odp/api/init.h
@@ -141,6 +141,10 @@ typedef struct odp_platform_init_t {
*
* This function must be called once before calling any other ODP API
* functions.
+ * The underlying implementation may have another way to get configuration
+ * related to platform_params (e.g. environmental variable, configuration
+ * file), but if the application passes platform_params, it should always
+ * supersede any other configuration data the platform has.
*
* @param params Those parameters that are interpreted by the ODP API.
* Use NULL to set all parameters to their defaults.