Skip to content

doc: Updates to Storage module readme#390

Merged
jtguggedal merged 1 commit intonrfconnect:mainfrom
divipillai:doc_storage
Sep 24, 2025
Merged

doc: Updates to Storage module readme#390
jtguggedal merged 1 commit intonrfconnect:mainfrom
divipillai:doc_storage

Conversation

@divipillai
Copy link
Copy Markdown
Collaborator

@divipillai divipillai commented Sep 23, 2025

Updates to Storage module readme

@divipillai divipillai force-pushed the doc_storage branch 2 times, most recently from 00647d1 to fdfccc9 Compare September 23, 2025 13:09
@divipillai divipillai marked this pull request as ready for review September 23, 2025 13:36
@divipillai divipillai changed the title doc: Updates to Storage module doc: Updates to Storage module readme Sep 23, 2025
1. Implement `struct storage_backend` (see `storage_backend.h`)
2. Provide `storage_backend_get()` function
3. Add Kconfig option in `Kconfig.storage`
1. Implement `struct storage_backend` (see `storage_backend.h`).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be 1. - 3. ?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

@jtguggedal jtguggedal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

A couple of issues reported by compliance:

ERROR   : Test Checkpatch failed: 
TYPO_SPELLING: 'SUCESS' may be misspelled - perhaps 'SUCCESS'?
File:docs/images/main_module_state_diagram.svg
Line:122
ERROR   : Test Checkpatch failed: 
TYPO_SPELLING: 'SUCESS' may be misspelled - perhaps 'SUCCESS'?
File:docs/images/main_module_state_diagram.svg
Line:188

doc updates to storage module readme.

Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
@divipillai
Copy link
Copy Markdown
Collaborator Author

Thanks!

A couple of issues reported by compliance:

ERROR   : Test Checkpatch failed: 
TYPO_SPELLING: 'SUCESS' may be misspelled - perhaps 'SUCCESS'?
File:docs/images/main_module_state_diagram.svg
Line:122
ERROR   : Test Checkpatch failed: 
TYPO_SPELLING: 'SUCESS' may be misspelled - perhaps 'SUCCESS'?
File:docs/images/main_module_state_diagram.svg
Line:188

Thank you! Fixed.

@jtguggedal jtguggedal merged commit 6c63bd8 into nrfconnect:main Sep 24, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants