Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Updates #545

Closed
yammajamma opened this issue Jul 17, 2020 · 1 comment · Fixed by #977 or #996
Closed

Documentation Updates #545

yammajamma opened this issue Jul 17, 2020 · 1 comment · Fixed by #977 or #996
Assignees
Labels
Milestone

Comments

@yammajamma
Copy link
Contributor

yammajamma commented Jul 17, 2020

Describe the bug

  1. In osapi-os-net.h, OS_SocketAccept lists addr as an [in] parameter where as it is an [out] parameter. This is where a new connection's incoming address is stored as an output to the function call and is not an input to the function.
    (File location: osal/src/os/inc/osapi-os-net.h)

  2. In osapi-os-core.h, OS_TaskCreate notates the input parameter "stack_size" as "stack_size: the size of the stack, or 0 to use a default stack size". A 0 input here is not valid and should be appointed an appropriate stack size.
    (File location: osal/src/os/inc/osapi-os-core.h)

  3. In osapi-os-filesys.h, OS_TimedRead/OS_TimedWrite. While the documentation is clear that these functions are used primarily with sockets, it is unclear how a socket may be used as an input parameter. The first input parameter "filedes" is notated as "The handle ID to operate on" but I think it would be prudent to add an additional comment to explain that this is also the socket ID. Perhaps these two functions should also be defined with the rest of the network functions in (osal/src/os/inc/osapi-os-net.h) instead of with functions used for file operations (osal/src/os/inc/osapi-os-filesys.h) for further specified use and clarity. It was not easily clear on how to send messages back and forth between a STREAM connection, as it is with DATAGRAM connections.
    (File location: osal/src/os/inc/osapi-os-filesys.h)

System observed on:
cFS Dev Server
OS: Ubuntu 18.04
Versions: OSAL 5.0.11.0

Additional context
Add any other context about the problem here.

Reporter Info
Yasir Majeed Khan
NASA GSFC/Emergent Space

@skliper skliper added this to the 6.0.0 milestone Dec 9, 2020
@skliper skliper added the docs label Dec 9, 2020
@jphickey
Copy link
Contributor

Looking back at existing issues, looks like 1 and 3 above were addressed by my recent PR #972, which fixes docs on OS_SocketAccept and OS_TimedRead/Write.

Only thing left here is to fix the stack size item (2).

@jphickey jphickey self-assigned this Apr 30, 2021
jphickey added a commit to jphickey/osal that referenced this issue Apr 30, 2021
Clarify use of the stack_size parameter, and that it should not be 0.
astrogeco added a commit that referenced this issue May 11, 2021
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
Partial fix (see also nasa#545), comments/documentation only
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants