Update on Documentation change

[BEplane]

Hello

SDK 15.3.0

4 year old post describing flash storage libraries:

https://devzone.nordicsemi.com/f/nordic-q-a/13821/difference-between-persistent-storage-libraries

10 month old post about updating documentation:

https://devzone.nordicsemi.com/f/nordic-q-a/43034/why-is-flash-storage-fstorage-and-flash-data-storage-fds-still-marked-as-experimental-in-the-sdk-15-2-0-documentation

bjorn-spockeli said:

I have reported this internally and asked that the documentation is updated to state which functionality that is considered production and which is not. 

Can I receive an update on this topic? I do not see any reference to what is considered production and what is considered experimental? Is this information located anywhere?

[bjorn-spockeli]

Hi Paul, 

Yes, this has been a recurring topic over the years and the documentation has sadly not been updated for the release of SDK v16.0.0.

One of the main reasons for this module staying in experimental for so long( and still is), is that its difficult to create tests that cover all the different use-cases that the module may be used for by our customers and being able to do the tests in a timely manner.

Hence, we have focused on providing test coverage for the essential parts from a BLE perspective. So in broad strokes, the FDS functionality that is used by the Peer Manager is extensively tested through our SDK testing suite and should be considered production ready SW. The remaining functionality/features, e.g. the FDS_THREADS feature is still considered experimental, i.e. we have not enable this in the examples that are run through the testing suite. 

We've also had some issues with FDS related to flash pages being corrupted if a power loss occurred at specific times during garbage collection, i.e. deletion of discarded records. This have been fixed in SDK v16.0.0 and is stated in the SDK release notes, which I recommend that you look through. 

I hope that this clarified a bit. 

Best regards

Bjørn

[BEplane]

To reword what you said, am I correct in my understanding that the examples use only the production ready features?

[bjorn-spockeli]

Yes, the functionality of FDS used by the Peer Manager to store bonding information is considered production ready.

Best regards

Bjørn

[BEplane]

When will this be updated in the documentation as it was reported 4 years ago? The update is about clearly documenting what is and is not experimental and why. And the related issues.

4 years seems plenty of time to clarify this in info center, instead of leaving everyone guessing and filling the forums with the same questions over time.

[bjorn-spockeli]

Hi Paul, 

Yes, I agree that this should have been updated a long time ago.  I will bump the requests for updating the documentation in our internal issue database and raise the issue with the developers responsible for the FDS module. 

Best regards

Bjørn