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

doc: storage: move "Secure Storage" and "Settings" chapters to "Storage" #85141

Merged

Conversation

butok
Copy link
Contributor

@butok butok commented Feb 4, 2025

Moves the "Secure Storage" and "Settings" chapters to the Storage folder.

nashif
nashif previously approved these changes Feb 5, 2025
Copy link
Collaborator

@tomi-font tomi-font left a comment

Choose a reason for hiding this comment

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

I see why one might want to have secure storage as part of storage as you can see it as another API that allows storing assets.
Though secure storage calls into NVS/ZMS which are here, so those don't quite live at the same level. And actually secure storage can even call into settings, yet another layer, which isn't even here (it's on its own).
So I don't know.
I'm not saying the current way is the way it should be and stay, but I'm not convinced by this exact change here.

doc/services/storage/secure_storage/secure_storage.rst Outdated Show resolved Hide resolved
@butok
Copy link
Contributor Author

butok commented Feb 10, 2025

I see why one might want to have secure storage as part of storage as you can see it as another API that allows storing assets. Though secure storage calls into NVS/ZMS which are here, so those don't quite live at the same level. And actually secure storage can even call into settings, yet another layer, which isn't even here (it's on its own). So I don't know. I'm not saying the current way is the way it should be and stay, but I'm not convinced by this exact change here.

From a user's point of view - it is the "storage".

BTW: Probably, the mentioned "settings" should be moved here too.

@tomi-font
Copy link
Collaborator

From a user's point of view - it is the "storage".
BTW: Probably, the mentioned "settings" should be moved here too.

I'd be fine having secure storage in there if settings joins too. Indeed for the user it's the storage solution. @de-nordic thoughts about having the settings documentation moved inside storage?

@de-nordic
Copy link
Collaborator

From a user's point of view - it is the "storage".
BTW: Probably, the mentioned "settings" should be moved here too.

I'd be fine having secure storage in there if settings joins too. Indeed for the user it's the storage solution. @de-nordic thoughts about having the settings documentation moved inside storage?

Settings is not in storage because, as far as I understand, it is not a storage itself, it is more to be a DB that can utilize different ways of storing/retrieving information.

@butok
Copy link
Contributor Author

butok commented Feb 11, 2025

From a user's point of view - it is the "storage".
BTW: Probably, the mentioned "settings" should be moved here too.

I'd be fine having secure storage in there if settings joins too. Indeed for the user it's the storage solution. @de-nordic thoughts about having the settings documentation moved inside storage?

Settings is not in storage because, as far as I understand, it is not a storage itself, it is more to be a DB that can utilize different ways of storing/retrieving information.

"that can utilize different ways of storing/retrieving information" - behavior of a storage ;)

@butok butok force-pushed the doc_move_secure_storage branch from 296f602 to 9f81f3b Compare February 12, 2025 11:38
@butok butok changed the title doc: storage: move "Secure Storage" chapter to "Storage" doc: storage: move "Secure Storage" and "Settings" chapters to "Storage" Feb 12, 2025
@butok
Copy link
Contributor Author

butok commented Feb 12, 2025

From a user's point of view - it is the "storage".
BTW: Probably, the mentioned "settings" should be moved here too.

I'd be fine having secure storage in there if settings joins too. Indeed for the user it's the storage solution. @de-nordic thoughts about having the settings documentation moved inside storage?

Hi @tomi-font
"Settings" has also been moved.
Now all storage - specific documentation is in one place.

@butok butok force-pushed the doc_move_secure_storage branch from 9f81f3b to d3649ff Compare February 12, 2025 11:46
@tomi-font tomi-font requested a review from de-nordic February 12, 2025 12:04
@de-nordic
Copy link
Collaborator

From a user's point of view - it is the "storage".
BTW: Probably, the mentioned "settings" should be moved here too.

I'd be fine having secure storage in there if settings joins too. Indeed for the user it's the storage solution. @de-nordic thoughts about having the settings documentation moved inside storage?

Settings is not in storage because, as far as I understand, it is not a storage itself, it is more to be a DB that can utilize different ways of storing/retrieving information.

"that can utilize different ways of storing/retrieving information" - behavior of a storage ;)

From a user's point of view - it is the "storage".
BTW: Probably, the mentioned "settings" should be moved here too.

I'd be fine having secure storage in there if settings joins too. Indeed for the user it's the storage solution. @de-nordic thoughts about having the settings documentation moved inside storage?

Hi @tomi-font "Settings" has also been moved. Now all storage - specific documentation is in one place.

Secure Storage does not fit there, this is dir for things nobody wants to admit maintaining ;)

de-nordic
de-nordic previously approved these changes Feb 12, 2025
Copy link
Collaborator

@de-nordic de-nordic left a comment

Choose a reason for hiding this comment

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

OK, if you really want.

@@ -210,7 +210,7 @@
('reference/peripherals/uart', 'hardware/peripherals/uart'),
('reference/peripherals/video', 'hardware/peripherals/video'),
('reference/pm/index', 'services/pm/api/index'),
('reference/settings/index', 'services/settings/index'),
('reference/settings/index', 'services/storage/settings/index'),
Copy link
Collaborator

Choose a reason for hiding this comment

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

you actually need a new entry for services/settings/index --> services/storage/settings/index please, as this is arguably the most important case to cover for e.g folks browsing the "old" page on LTS3 docs and interested in looking at the newest version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @kartben.
The requested entry has been added.

Copy link
Collaborator

Choose a reason for hiding this comment

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

How about having an entry for secure_storage as well? Would it make sense?

Copy link
Collaborator

Choose a reason for hiding this comment

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

oh yes, of course, missed that

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@tomi-font @kartben
Just added.

kartben
kartben previously approved these changes Feb 14, 2025
@kartben kartben added this to the v4.1.0 milestone Feb 14, 2025
de-nordic
de-nordic previously approved these changes Feb 14, 2025
Copy link
Collaborator

@tomi-font tomi-font left a comment

Choose a reason for hiding this comment

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

@butok butok dismissed stale reviews from de-nordic and kartben via 4c68e15 February 14, 2025 12:38
@butok butok force-pushed the doc_move_secure_storage branch 2 times, most recently from 4c68e15 to fd7f409 Compare February 14, 2025 12:41
Moves the "Secure Storage" and "Settings" chapters to the Storage folder.

Signed-off-by: Andrej Butok <[email protected]>
@butok butok force-pushed the doc_move_secure_storage branch from fd7f409 to 594791a Compare February 14, 2025 14:12
@kartben kartben merged commit c489a0d into zephyrproject-rtos:main Feb 14, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants