nrf_modem: doc: cleanup function references #42
Closed
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
Collaborator
anhmolt
commented
Feb 21, 2024
anhmolt
commented
- Clean up function references. Add nrf_accept and nrf_setdnsaddr to list of supported functions.
- Remove superfluous nrf_errno mentions when referencing specific errnos for the NRF_SO_SEC_DTLS_CONN_SAVE and NRF_SO_SEC_DTLS_CONN_LOAD socket options.
anhmolt
force-pushed
the
nrf_modem-doc-improvements
branch
from
90085c4 to
c31b38d
Compare
lemrey
reviewed
Feb 22, 2024
| @@ -17,23 +17,25 @@ Following is a list of supported functions: | |||
|
|
|||
| * :c:func:`nrf_socket` | |||
| * :c:func:`nrf_close` | |||
| * :c:func:`nrf_fcntl` | |||
There was a problem hiding this comment.
How did you re-arrange this list?
There was a problem hiding this comment.
Same order as in nrf_socket.h. We can drop re-arranging if you think that is better.
There was a problem hiding this comment.
Moved re-arranging to separate commit.
There was a problem hiding this comment.
I think the order of those functions in nrf_socket.h could be improved, it seems a bit random.
anhmolt
force-pushed
the
nrf_modem-doc-improvements
branch
5 times, most recently
from
163dcd6 to
8243cc7
Compare
This commit updates the documentation to remove the custom types `nrf_sec_cipher_t`, `nrf_sec_peer_verify_t`, `nrf_sec_role_t`, and `nrf_sec_session_cache_t`. Signed-off-by: Mirko Covizzi <[email protected]>
This commit extends the documentation explaining how to use the special security tags reserved for TLS traffic decryption. Signed-off-by: Mirko Covizzi <[email protected]>
This commit updates the documentation to remove the deprecated `NRF_SO_RAI_` socket options. This commit updates the documentation to add the `NRF_SO_RAI` socket option and the `NRF_RAI_NO_DATA`, `NRF_RAI_LAST`, `NRF_RAI_ONE_RESP`, `NRF_RAI_ONGOING`, and `NRF_RAI_WAIT_MORE` values. Added documentation page for RAI. Signed-off-by: Mirko Covizzi <[email protected]>
This commit rearranges the socket options in the table to align with the order of the socket option descriptions under the table. Signed-off-by: Mirko Covizzi <[email protected]>
This commit moves `Socket options and functions`, `PDN`, `TLS/DTLS`, and `RAI` from `sockets.rst` to the `sockets` subfolder in their own respective document page. Signed-off-by: Mirko Covizzi <[email protected]> Co-authored-by: divya pillai <[email protected]>
This commit updates the layout of the socket subpages to align with style guidelines. Signed-off-by: divya pillai <[email protected]> Signed-off-by: Mirko Covizzi <[email protected]>
This commit fixes a minor typo. Signed-off-by: Mirko Covizzi <[email protected]>
This commit moves some text to a more fitting paragraph. Signed-off-by: Mirko Covizzi <[email protected]>
Removed redundant sentence. Signed-off-by: Mirko Covizzi <[email protected]>
This commit adds documentation for raw sockets. Signed-off-by: Mirko Covizzi <[email protected]>
* Add CFUN callbacks to doc. * Add mutexes to documentation. Signed-off-by: Eivind Jølsgard <[email protected]>
Add documentation for new feature. Signed-off-by: Emanuele Di Santo <[email protected]>
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]>
Clean up function references. Add nrf_accept and nrf_setdnsaddr to list of supported functions. Signed-off-by: Andreas Moltumyr <[email protected]>
Change nrf_errno mentions to simply errno when referencing specific errnos for the NRF_SO_SEC_DTLS_CONN_SAVE and NRF_SO_SEC_DTLS_CONN_LOAD socket options. Signed-off-by: Andreas Moltumyr <[email protected]>
anhmolt
force-pushed
the
nrf_modem-doc-improvements
branch
2 times, most recently
from
ef1b36f to
c661cba
Compare
MirkoCovizzi
approved these changes
Feb 23, 2024
|
Closing this and opening a PR directly to nrfconnect/sdk-nrfxlib. nrfconnect#1254 |
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.