sys: usermode: Document 0 size buffer memory check

Flavio Ceolin · dleach02 · commit 2649e4c0bef3 · 2020-05-05T13:04:50.000-05:00
Documenting that 0 size buffer has undefined behavior. See: #23239 Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
diff --git a/include/sys/arch_interface.h b/include/sys/arch_interface.h
@@ -572,6 +572,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
`@@ -572,6 +572,8 @@ void arch_mem_domain_destroy(struct k_mem_domain *domain);`
`572`	`572`	`* if the supplied memory buffer spans multiple enabled memory management`
`573`	`573`	`* regions (even if all such regions permit user access).`
`574`	`574`	`*`
	`575`	`+ * @warning 0 size buffer has undefined behavior.`
	`576`	`+ *`
`575`	`577`	`* @param addr start address of the buffer`
`576`	`578`	`* @param size the size of the buffer`
`577`	`579`	`* @param write If nonzero, additionally check if the area is writable.`