(nuttx) 02/02: Documentation: Describe the return value of up_create_stack().

[ac...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

acassis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git

commit 392ccef90b23e38a5e2090602f78c575b77f8beb
Author: Marco Casaroli <ma...@gmail.com>
AuthorDate: Sat Oct 17 21:54:40 2026 +0200

    Documentation: Describe the return value of up_create_stack().
    
    The arch API page did not say what up_create_stack() returns.
    
    Add the return value: zero on success, -ENOMEM if the stack cannot be
    allocated.
    
    Assisted-by: Claude Code:claude-opus-5-5
    Signed-off-by: Marco Casaroli <ma...@gmail.com>
---
 Documentation/os/arch/arch_api.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/os/arch/arch_api.rst b/Documentation/os/arch/arch_api.rst
index 8afe4bcb480..525fe31b603 100644
--- a/Documentation/os/arch/arch_api.rst
+++ b/Documentation/os/arch/arch_api.rst
@@ -81,6 +81,10 @@ APIs Exported by Architecture-Specific Logic to NuttX
      and threads must come from memory that is accessible to user
      code.
 
+  :return:
+    Zero (``OK``) on success; ``-ENOMEM`` if the stack cannot be
+    allocated.
+
 .. c:function:: STATUS up_use_stack(FAR struct tcb_s *tcb, FAR void *stack, size_t stack_size)
 
   Setup up stack-related information in the TCB