nrf_modem: doc: update NRF_SO_RCVTIMEO for accept #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lemrey
reviewed
Feb 20, 2024
anhmolt
reviewed
Feb 20, 2024
eivindj-nordic
force-pushed
the
accept_timeo
branch
from
8ad124f
to
ca47186
Compare
lemrey
reviewed
Feb 21, 2024
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
eivindj-nordic
force-pushed
the
accept_timeo
branch
2 times, most recently
from
1db6005
to
903b8c8
Compare
Updated documentation to use macro, except changelog. |
This comment was marked as resolved.
This comment was marked as resolved.
anhmolt
reviewed
Feb 21, 2024
|
Found some more things we can improve while reviewing this, so I opened #42. |
eivindj-nordic
force-pushed
the
accept_timeo
branch
2 times, most recently
from
7f76aac
to
b5c71c9
Compare
anhmolt
approved these changes
Feb 22, 2024
lemrey
reviewed
Feb 22, 2024
nrf_modem/doc/fault_handling.rst
Outdated
| @@ -35,19 +35,19 @@ The application can reinitialize the modem by reinitializing the Modem library t | |||
| .. important:: | |||
| If modem traces are enabled, the modem continues to output trace data (a coredump) in the event of a fault, even after signaling the fault to the application. | |||
| To make sure the application is able to retrieve the coredump correctly, the application must not re-initialize the modem until all the outstanding trace data has been processed. | |||
| The :c:func:`nrf_modem_trace_get()` function will return ``-ENODATA`` when all outstanding trace data has been processed by the application. | |||
| The :c:func:`nrf_modem_trace_get()` function will return :c:macro:`-NRF_ENODATA` when all outstanding trace data has been processed by the application. | |||
There was a problem hiding this comment.
Does it work to have the - minus in the macro name? Those generate links in HTML to the macro definition, how are they working with the minus sign in front?
There was a problem hiding this comment.
That is a good point..
Maybe do as @MirkoCovizzi suggested in #42, and write
return negative :c:macro:`NRF_ENODATA`
There was a problem hiding this comment.
Thanks, updated.
There was a problem hiding this comment.
Last changes ended up in the wrong commit, if I'm not mistaken.
eivindj-nordic
force-pushed
the
accept_timeo
branch
3 times, most recently
from
89c2422
to
52dac43
Compare
Use :c:macro: for errnos. Signed-off-by: Eivind Jølsgard <[email protected]>
The NRF_SO_RCVTIMEO is used to set the timeout in accept. Signed-off-by: Eivind Jølsgard <[email protected]>
eivindj-nordic
force-pushed
the
accept_timeo
branch
from
52dac43
to
b47de7e
Compare
lemrey
approved these changes
Feb 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The NRF_SO_RCVTIMEO is used to set the timeout in accept.