Explaining how to opt in modules

[RonEld]

Description

Add a section in the CC Readme file explaining how to enable the optional module.
Dependent on #10907 , #10913 , #10947

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[x ] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@ARMmbed/mbed-os-crypto

Release Notes

[ciarmcom]

@RonEld, thank you for your changes.
@ARMmbed/mbed-os-crypto @ARMmbed/mbed-os-maintainers please review.

[0xc0170]

support typo

[RonEld]

done

[RonEld]

@0xc0170 Does this require review from @ARMmbed/mbed-docs ?

[0xc0170]

@AnotherButler will do better :) Otherwise looks good to me

[0xc0170]

Suggested change

	There are three additional modules that have alternative implementation support, which are not enabled by default.
	There are three additional modules with alternative implementation support, disabled by default.

[artokin]

@AnotherButler , please add your review comments.

[AnotherButler]

Should this be added to our public, published Mbed OS documentation, or is it not going onto master?

[RonEld]

@AnotherButler This is secifically for Cryptocell, so I think this readme file is enough.
It is also intended for the patch release, as for next release, we will make these optional features, not optional, I believe

[AnotherButler]

@Patater Will we want to add this to the published docs when these features are no longer optional?

[Patater]

We want this documented both for the patch release, where the feature is optional (default off), as well as for a later release, where the feature becomes default on.

[RonEld]

@Patater Why do you want to keep this when the feature is not optional? Perhaps we should modify the file how to opt-out features, which will be turned on by default.

@AnotherButler Since this is specific for the cryptocell porting, I don't see a reason why to put this in our published docs, unless:

1. We make a document specific for Cryptocell porting, which I don't think is needed at the moment, since currently we only have one mbed os platform with Cryptocell feature.
2. We make a generic document on how to opt out \ in features, or modify https://os.mbed.com/docs/mbed-os/v5.13/porting/hardware-accelerated-crypto.html with this information

[AnotherButler]

FYI @iriark01

[oliverjharper]

@yanesca can you take a look at this in Jaeden's absence please?

[yanesca]

I agree with @Patater that it is best to keep this around. The user might want either hardware acceleration or full functionality. Whichever is the default, we should explain how to achieve the other.

@RonEld you mention two ways to sync the readme with the default option in the source:

1. update the readme when changing the default option and describe how to opt-out.
2. make the readme generic explaining both opt-in and opt-out

Which one would you like to do?

[RonEld]

@yanesca

@RonEld you mention two ways to sync the readme with the default option in the source:

1. update the readme when changing the default option and describe how to opt-out.
2. make the readme generic explaining both opt-in and opt-out
   Which one would you like to do?

I think the first option is prefered.

The preceding PRs have been merged, and I think we should merge this PR.
What is blocking this?

[yanesca]

@RonEld When is the default going to change? How can we make it sure that we don't forget to update this documentation?

[RonEld]

My plan was that the PRs will be inserted to the patch releases, and for next major release, make default opted-in.
However, the PRs were merged into next major release( 2.14), so we will probably change the default in 2.15, with the documentation in the same PR.

Once this PR will be merged, I will make the PR changing the default in the modules, updating this documentation with it, targeting 2.15

[0xc0170]

terget stm32F446ze on nucleo board

They were integrated. @RonEld shall we progress here?

[0xc0170]

CI started

[RonEld]

@0xc0170 I don't understand your comment
This PR is not related to stm32F446ze on nucleo board

IMHO, we can and should progress with this PR

[0xc0170]

Dependent on #10907 , #10913 , #10947

This one I was supposed to copy-paste, not the nucleo text ! :-)

[0xc0170]

CI started