Patchwork [2/2] mtd: mark tests EXPERIMENTAL

login
register
mail settings
Submitter Wolfram Sang
Date Oct. 25, 2011, 9:09 a.m.
Message ID <1319533791-32605-2-git-send-email-w.sang@pengutronix.de>
Download mbox | patch
Permalink /patch/121514/
State New
Headers show

Comments

Wolfram Sang - Oct. 25, 2011, 9:09 a.m.
The tests may erase mtd devices, so mark them EXPERIMENTAL and emphasize
this fact in the Kconfig entry, so users will think twice before running
them.

Signed-off-by: Wolfram Sang <w.sang@pengutronix.de>
---
 drivers/mtd/Kconfig |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)
Artem Bityutskiy - Oct. 29, 2011, 8:30 p.m.
On Tue, 2011-10-25 at 11:09 +0200, Wolfram Sang wrote:
> The tests may erase mtd devices, so mark them EXPERIMENTAL and emphasize
> this fact in the Kconfig entry, so users will think twice before running
> them.
> 
> Signed-off-by: Wolfram Sang <w.sang@pengutronix.de>
> ---
>  drivers/mtd/Kconfig |    5 ++++-
>  1 files changed, 4 insertions(+), 1 deletions(-)
> 
> diff --git a/drivers/mtd/Kconfig b/drivers/mtd/Kconfig
> index 4be8373..81d9b92 100644
> --- a/drivers/mtd/Kconfig
> +++ b/drivers/mtd/Kconfig
> @@ -27,12 +27,15 @@ config MTD_DEBUG_VERBOSE
>  
>  config MTD_TESTS
>  	tristate "MTD tests support"
> -	depends on m
> +	depends on m && EXPERIMENTAL
>  	help
>  	  This option includes various MTD tests into compilation. The tests
>  	  should normally be compiled as kernel modules. The modules perform
>  	  various checks and verifications when loaded.
>  
> +	  WARNING: Some of the tests will ERASE THE CONTENT of mtd devices!
> +	  Do not use these tests unless you are sure you really need to.
> +

I am OK with this close, but I am not sure about the EXPERIMENTAL. I
though this is used for the code which is considered to be "not ready"
for real use, while the tests work well.

Artem.
Wolfram Sang - Oct. 29, 2011, 8:40 p.m.
> > diff --git a/drivers/mtd/Kconfig b/drivers/mtd/Kconfig
> > index 4be8373..81d9b92 100644
> > --- a/drivers/mtd/Kconfig
> > +++ b/drivers/mtd/Kconfig
> > @@ -27,12 +27,15 @@ config MTD_DEBUG_VERBOSE
> >  
> >  config MTD_TESTS
> >  	tristate "MTD tests support"
> > -	depends on m
> > +	depends on m && EXPERIMENTAL
> 
> I am OK with this close, but I am not sure about the EXPERIMENTAL. I
> though this is used for the code which is considered to be "not ready"
> for real use, while the tests work well.

Well, yeah, it is not perfect, but the closest I could come up with
(EXPERT is a lot worse). My reasoning went a bit in the direction of
"you usually need the tests for experimental drivers".
Artem Bityutskiy - Oct. 30, 2011, 12:29 p.m.
On Sat, 2011-10-29 at 22:40 +0200, Wolfram Sang wrote:
> > > diff --git a/drivers/mtd/Kconfig b/drivers/mtd/Kconfig
> > > index 4be8373..81d9b92 100644
> > > --- a/drivers/mtd/Kconfig
> > > +++ b/drivers/mtd/Kconfig
> > > @@ -27,12 +27,15 @@ config MTD_DEBUG_VERBOSE
> > >  
> > >  config MTD_TESTS
> > >  	tristate "MTD tests support"
> > > -	depends on m
> > > +	depends on m && EXPERIMENTAL
> > 
> > I am OK with this close, but I am not sure about the EXPERIMENTAL. I
> > though this is used for the code which is considered to be "not ready"
> > for real use, while the tests work well.
> 
> Well, yeah, it is not perfect, but the closest I could come up with
> (EXPERT is a lot worse). My reasoning went a bit in the direction of
> "you usually need the tests for experimental drivers".

I see, but I think that this is not what EXPERIMENTAL mean. It is better
to add "(DANGEROUS)" to the title as it is recommended in
Documentation/CodyngStyle.

Artem.

Patch

diff --git a/drivers/mtd/Kconfig b/drivers/mtd/Kconfig
index 4be8373..81d9b92 100644
--- a/drivers/mtd/Kconfig
+++ b/drivers/mtd/Kconfig
@@ -27,12 +27,15 @@  config MTD_DEBUG_VERBOSE
 
 config MTD_TESTS
 	tristate "MTD tests support"
-	depends on m
+	depends on m && EXPERIMENTAL
 	help
 	  This option includes various MTD tests into compilation. The tests
 	  should normally be compiled as kernel modules. The modules perform
 	  various checks and verifications when loaded.
 
+	  WARNING: Some of the tests will ERASE THE CONTENT of mtd devices!
+	  Do not use these tests unless you are sure you really need to.
+
 config MTD_REDBOOT_PARTS
 	tristate "RedBoot partition table parsing"
 	---help---