sys: usermode: Document 0 size buffer memory check

Flavio Ceolin · nashif · commit f032de6cc896 · 2020-03-24T19:22:48.000-04:00
Documenting that 0 size buffer has undefined behavior. See: #23239 Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
diff --git a/kernel/include/kernel_internal.h b/kernel/include/kernel_internal.h
@@ -137,6 +137,8 @@ extern void z_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
`@@ -137,6 +137,8 @@ extern void z_arch_mem_domain_destroy(struct k_mem_domain *domain);`
`137`	`137`	`* if the supplied memory buffer spans multiple enabled memory management`
`138`	`138`	`* regions (even if all such regions permit user access).`
`139`	`139`	`*`
	`140`	`+ * @warning 0 size buffer has undefined behavior.`
	`141`	`+ *`
`140`	`142`	`* @param addr start address of the buffer`
`141`	`143`	`* @param size the size of the buffer`
`142`	`144`	`* @param write If nonzero, additionally check if the area is writable.`