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

Deprecates NVStore #11785

Merged
merged 1 commit into from Oct 31, 2019
Merged

Deprecates NVStore #11785

merged 1 commit into from Oct 31, 2019

Conversation

VeijoPesonen
Copy link
Contributor

@VeijoPesonen VeijoPesonen commented Oct 31, 2019

Description (required)

Marks the existing NVStore implementation as deprecated. The implementation will be removed on the next major release. Users are expected to migrate on KVStore instead if they are looking for similar storage solution.

Summary of change (What the change is for and why)

NVStore API is marked as deprecated.

Documentation (Details of any document updates required)

NVStore shouldn't be mentioned anywhere in our documentation from the next major release onwards.


Pull request type (required)

[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[X] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results (required)

[] No Tests required for this change (E.g docs only update)
[X] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers (optional)

@SeppoTakalo
@JanneKiiskila


Release Notes (required for feature/major PRs)

Summary of changes

NVStore is marked as deprecated

Impact of changes

NVStore won't be available from the next major release onwards

Migration actions required

Users must switch to use KVStore. For documentation please see Docs › APIs › Storage › KVStore

@SeppoTakalo SeppoTakalo self-requested a review October 31, 2019 11:58
@mbed-ci
Copy link

mbed-ci commented Oct 31, 2019

Test run: SUCCESS

Summary: 11 of 11 test jobs passed
Build number : 1
Build artifacts

@0xc0170
Copy link
Contributor

0xc0170 commented Oct 31, 2019

[X] Feature update (New feature / Functionality change / New API)

This one should have "Release notes" - this deprecation should be there - please fill in details

@VeijoPesonen
Copy link
Contributor Author

@0xc0170 Release notes-section updated as requested.

@0xc0170
Copy link
Contributor

0xc0170 commented Oct 31, 2019

Not certain why jenkins failed to update the hook, I restarted the test

@adbridge
Copy link
Contributor

@VeijoPesonen Could you please fill in the Description section properly. Please refer to the guiding notes if you are unsure of how. Thanks.

@VeijoPesonen
Copy link
Contributor Author

@VeijoPesonen Could you please fill in the Description section properly. Please refer to the guiding notes if you are unsure of how. Thanks.

@adbridge, description added. Please let me know if something relevant is still missing.

@adbridge
Copy link
Contributor

@VeijoPesonen thank you for adding the description. Are there any specific migration issues users may face having to move from using NVStore to KVStore? Should the migration section point them to any documentation to help ? Remember all the Release Notes section gets published with the Minor release.

@VeijoPesonen
Copy link
Contributor Author

Are there any specific migration issues users may face having to move from using NVStore to KVStore?

Not that I know of. @teetak01, @TeroJaasko Are you aware of any possible issues?

@JanneKiiskila
Copy link
Contributor

There is no migration story, as far as I know. So, it is a hard break and whomever is using NVStore -> can't update to an Mbed OS without NVStore support anymore.

@mbed-ci
Copy link

mbed-ci commented Oct 31, 2019

Test run: SUCCESS

Summary: 11 of 11 test jobs passed
Build number : 2
Build artifacts

@0xc0170 0xc0170 merged commit 4c7c7f8 into ARMmbed:master Oct 31, 2019
@VeijoPesonen VeijoPesonen deleted the deprecate_nvstore branch November 1, 2019 08:12
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.

None yet

6 participants