sys: usermode: Document 0 size buffer memory check

Flavio Ceolin · hakehuang · commit 2ee7f5def413 · 2020-03-19T01:40:51.000+08:00
Documenting that 0 size buffer has undefined behavior. See: zephyrproject-rtos#23239 Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
diff --git a/include/sys/arch_interface.h b/include/sys/arch_interface.h
@@ -578,6 +578,8 @@ void arch_mem_domain_destroy(struct k_mem_domain *domain);
  * if the supplied memory buffer spans multiple enabled memory management
  * regions (even if all such regions permit user access).
  *
+ * @warning 0 size buffer has undefined behavior.
+ *
  * @param addr start address of the buffer
  * @param size the size of the buffer
  * @param write If nonzero, additionally check if the area is writable.

Original file line number	Diff line number	Diff line change
`@@ -578,6 +578,8 @@ void arch_mem_domain_destroy(struct k_mem_domain *domain);`
`578`	`578`	`* if the supplied memory buffer spans multiple enabled memory management`
`579`	`579`	`* regions (even if all such regions permit user access).`
`580`	`580`	`*`
	`581`	`+ * @warning 0 size buffer has undefined behavior.`
	`582`	`+ *`
`581`	`583`	`* @param addr start address of the buffer`
`582`	`584`	`* @param size the size of the buffer`
`583`	`585`	`* @param write If nonzero, additionally check if the area is writable.`