[PATCH] mtd: update documentation of mtd_device_parse_register()

[PATCH] mtd: update documentation of mtd_device_parse_register()

[Rafał Miłecki]

From: Rafał Miłecki <rafal@milecki.pl>

In the commit 2c77c57d22adb ("mtd: move code adding master MTD out of
mtd_add_device_partitions()") behavior of mtd_device_parse_register()
has very slightly changed. It's a pretty non-significant order change
to match updated function behavior.

Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
---
 drivers/mtd/mtdcore.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/drivers/mtd/mtdcore.c b/drivers/mtd/mtdcore.c
index f25d65ea7149..20d5262c5b5c 100644
--- a/drivers/mtd/mtdcore.c
+++ b/drivers/mtd/mtdcore.c
@@ -673,14 +673,13 @@ static void mtd_set_dev_defaults(struct mtd_info *mtd)
  * 'parse_mtd_partitions()') and MTD device and partitions registering. It
  * basically follows the most common pattern found in many MTD drivers:
  *
- * * It first tries to probe partitions on MTD device @mtd using parsers
+ * * If the MTD_PARTITIONED_MASTER option is set, then the device as a whole is
+ *   registered first.
+ * * Then It tries to probe partitions on MTD device @mtd using parsers
  *   specified in @types (if @types is %NULL, then the default list of parsers
  *   is used, see 'parse_mtd_partitions()' for more information). If none are
  *   found this functions tries to fallback to information specified in
  *   @parts/@nr_parts.
- * * If any partitioning info was found, this function registers the found
- *   partitions. If the MTD_PARTITIONED_MASTER option is set, then the device
- *   as a whole is registered first.
  * * If no partitions were found this function just registers the MTD device
  *   @mtd and exits.
  *
-- 
2.11.0

Re: [PATCH] mtd: update documentation of mtd_device_parse_register()

[Richard Weinberger]

Am Dienstag, 27. März 2018, 15:36:47 CEST schrieb Rafał Miłecki:
> From: Rafał Miłecki <rafal@milecki.pl>
> 
> In the commit 2c77c57d22adb ("mtd: move code adding master MTD out of
> mtd_add_device_partitions()") behavior of mtd_device_parse_register()
> has very slightly changed. It's a pretty non-significant order change
> to match updated function behavior.
> 
> Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
> ---
>  drivers/mtd/mtdcore.c | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/mtd/mtdcore.c b/drivers/mtd/mtdcore.c
> index f25d65ea7149..20d5262c5b5c 100644
> --- a/drivers/mtd/mtdcore.c
> +++ b/drivers/mtd/mtdcore.c
> @@ -673,14 +673,13 @@ static void mtd_set_dev_defaults(struct mtd_info *mtd)
>   * 'parse_mtd_partitions()') and MTD device and partitions registering. It
>   * basically follows the most common pattern found in many MTD drivers:
>   *
> - * * It first tries to probe partitions on MTD device @mtd using parsers
> + * * If the MTD_PARTITIONED_MASTER option is set, then the device as a whole is
> + *   registered first.
> + * * Then It tries to probe partitions on MTD device @mtd using parsers
>   *   specified in @types (if @types is %NULL, then the default list of parsers
>   *   is used, see 'parse_mtd_partitions()' for more information). If none are
>   *   found this functions tries to fallback to information specified in
>   *   @parts/@nr_parts.
> - * * If any partitioning info was found, this function registers the found
> - *   partitions. If the MTD_PARTITIONED_MASTER option is set, then the device
> - *   as a whole is registered first.
>   * * If no partitions were found this function just registers the MTD device
>   *   @mtd and exits.
>   *
> 

Thanks for taking care of docs. :-)

Reviewed-by: Richard Weinberger <richard@nod.at>

Thanks,
//richard

Re: [PATCH] mtd: update documentation of mtd_device_parse_register()

[Boris Brezillon]

On Tue, 27 Mar 2018 21:18:14 +0200
Richard Weinberger <richard@nod.at> wrote:

> Am Dienstag, 27. März 2018, 15:36:47 CEST schrieb Rafał Miłecki:
> > From: Rafał Miłecki <rafal@milecki.pl>
> > 
> > In the commit 2c77c57d22adb ("mtd: move code adding master MTD out of
> > mtd_add_device_partitions()") behavior of mtd_device_parse_register()
> > has very slightly changed. It's a pretty non-significant order change
> > to match updated function behavior.
> > 
> > Signed-off-by: Rafał Miłecki <rafal@milecki.pl>

Applied.

Thanks,

Boris

> > ---
> >  drivers/mtd/mtdcore.c | 7 +++----
> >  1 file changed, 3 insertions(+), 4 deletions(-)
> > 
> > diff --git a/drivers/mtd/mtdcore.c b/drivers/mtd/mtdcore.c
> > index f25d65ea7149..20d5262c5b5c 100644
> > --- a/drivers/mtd/mtdcore.c
> > +++ b/drivers/mtd/mtdcore.c
> > @@ -673,14 +673,13 @@ static void mtd_set_dev_defaults(struct mtd_info *mtd)
> >   * 'parse_mtd_partitions()') and MTD device and partitions registering. It
> >   * basically follows the most common pattern found in many MTD drivers:
> >   *
> > - * * It first tries to probe partitions on MTD device @mtd using parsers
> > + * * If the MTD_PARTITIONED_MASTER option is set, then the device as a whole is
> > + *   registered first.
> > + * * Then It tries to probe partitions on MTD device @mtd using parsers
> >   *   specified in @types (if @types is %NULL, then the default list of parsers
> >   *   is used, see 'parse_mtd_partitions()' for more information). If none are
> >   *   found this functions tries to fallback to information specified in
> >   *   @parts/@nr_parts.
> > - * * If any partitioning info was found, this function registers the found
> > - *   partitions. If the MTD_PARTITIONED_MASTER option is set, then the device
> > - *   as a whole is registered first.
> >   * * If no partitions were found this function just registers the MTD device
> >   *   @mtd and exits.
> >   *
> >   
> 
> Thanks for taking care of docs. :-)
> 
> Reviewed-by: Richard Weinberger <richard@nod.at>
> 
> Thanks,
> //richard
> 



-- 
Boris Brezillon, Bootlin (formerly Free Electrons)
Embedded Linux and Kernel engineering
https://bootlin.com