[PATCH] doc: drop some incorrect instructions

[PATCH] doc: drop some incorrect instructions

[liu.ming50]

From: Ming Liu <liu.ming50@gmail.com>

image_types bbclass now is being inherited mandatorily in image.bbclass
through the variable IMGCLASSES, and the users do not have to inherit
it in their customized image type bbclass, or put it in IMAGE_CLASSES.

Drop the incorrect descriptions, it's confusing the developers.

Signed-off-by: Ming Liu <liu.ming50@gmail.com>
---
 documentation/ref-manual/ref-classes.xml | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 24d7a0a..876e242 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1275,15 +1275,10 @@
     </para>
 
     <para>
-        By default, this class is enabled through the
-        <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link>
-        variable in
+        By default, this class is enabled mandatorily in
         <link linkend='ref-classes-image'><filename>image.bbclass</filename></link>.
         If you define your own image types using a custom BitBake class and
-        then use <filename>IMAGE_CLASSES</filename> to enable it, the custom
-        class must either inherit <filename>image_types</filename> or
-        <filename>image_types</filename> must also appear in
-        <filename>IMAGE_CLASSES</filename>.
+        then use <filename>IMAGE_CLASSES</filename> to enable it.
     </para>
 
     <para>
-- 
2.7.4

Re: [PATCH] doc: drop some incorrect instructions

[Scott Rifenbark]

[-- Attachment #1: Type: text/plain, Size: 2202 bytes --]

Ming,

I could not simply apply this patch.  I had to do some re-writing for
clarity.  Please look at this link to the updated section on the
image_types class and let me know if this is technically correct.

https://yoctoproject.org/docs/2.6/ref-manual/ref-manual.html#ref-classes-image_types

Thanks,
Scott

On Wed, Nov 14, 2018 at 11:06 AM <liu.ming50@gmail.com> wrote:

> From: Ming Liu <liu.ming50@gmail.com>
>
> image_types bbclass now is being inherited mandatorily in image.bbclass
> through the variable IMGCLASSES, and the users do not have to inherit
> it in their customized image type bbclass, or put it in IMAGE_CLASSES.
>
> Drop the incorrect descriptions, it's confusing the developers.
>
> Signed-off-by: Ming Liu <liu.ming50@gmail.com>
> ---
>  documentation/ref-manual/ref-classes.xml | 9 ++-------
>  1 file changed, 2 insertions(+), 7 deletions(-)
>
> diff --git a/documentation/ref-manual/ref-classes.xml
> b/documentation/ref-manual/ref-classes.xml
> index 24d7a0a..876e242 100644
> --- a/documentation/ref-manual/ref-classes.xml
> +++ b/documentation/ref-manual/ref-classes.xml
> @@ -1275,15 +1275,10 @@
>      </para>
>
>      <para>
> -        By default, this class is enabled through the
> -        <link
> linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link>
> -        variable in
> +        By default, this class is enabled mandatorily in
>          <link
> linkend='ref-classes-image'><filename>image.bbclass</filename></link>.
>          If you define your own image types using a custom BitBake class
> and
> -        then use <filename>IMAGE_CLASSES</filename> to enable it, the
> custom
> -        class must either inherit <filename>image_types</filename> or
> -        <filename>image_types</filename> must also appear in
> -        <filename>IMAGE_CLASSES</filename>.
> +        then use <filename>IMAGE_CLASSES</filename> to enable it.
>      </para>
>
>      <para>
> --
> 2.7.4
>
> --
> _______________________________________________
> Openembedded-core mailing list
> Openembedded-core@lists.openembedded.org
> http://lists.openembedded.org/mailman/listinfo/openembedded-core
>

[-- Attachment #2: Type: text/html, Size: 3262 bytes --]

Re: [PATCH] doc: drop some incorrect instructions

[Ming Liu]

[-- Attachment #1: Type: text/plain, Size: 2506 bytes --]

Hi, Scott:

Thanks for the re-writing, I think it's correct technically, the incorrect
description had been removed.

//Ming Liu

Scott Rifenbark <srifenbark@gmail.com> 於 2018年11月14日 週三 下午8:36寫道：

> Ming,
>
> I could not simply apply this patch.  I had to do some re-writing for
> clarity.  Please look at this link to the updated section on the
> image_types class and let me know if this is technically correct.
>
>
> https://yoctoproject.org/docs/2.6/ref-manual/ref-manual.html#ref-classes-image_types
>
> Thanks,
> Scott
>
> On Wed, Nov 14, 2018 at 11:06 AM <liu.ming50@gmail.com> wrote:
>
>> From: Ming Liu <liu.ming50@gmail.com>
>>
>> image_types bbclass now is being inherited mandatorily in image.bbclass
>> through the variable IMGCLASSES, and the users do not have to inherit
>> it in their customized image type bbclass, or put it in IMAGE_CLASSES.
>>
>> Drop the incorrect descriptions, it's confusing the developers.
>>
>> Signed-off-by: Ming Liu <liu.ming50@gmail.com>
>> ---
>>  documentation/ref-manual/ref-classes.xml | 9 ++-------
>>  1 file changed, 2 insertions(+), 7 deletions(-)
>>
>> diff --git a/documentation/ref-manual/ref-classes.xml
>> b/documentation/ref-manual/ref-classes.xml
>> index 24d7a0a..876e242 100644
>> --- a/documentation/ref-manual/ref-classes.xml
>> +++ b/documentation/ref-manual/ref-classes.xml
>> @@ -1275,15 +1275,10 @@
>>      </para>
>>
>>      <para>
>> -        By default, this class is enabled through the
>> -        <link
>> linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link>
>> -        variable in
>> +        By default, this class is enabled mandatorily in
>>          <link
>> linkend='ref-classes-image'><filename>image.bbclass</filename></link>.
>>          If you define your own image types using a custom BitBake class
>> and
>> -        then use <filename>IMAGE_CLASSES</filename> to enable it, the
>> custom
>> -        class must either inherit <filename>image_types</filename> or
>> -        <filename>image_types</filename> must also appear in
>> -        <filename>IMAGE_CLASSES</filename>.
>> +        then use <filename>IMAGE_CLASSES</filename> to enable it.
>>      </para>
>>
>>      <para>
>> --
>> 2.7.4
>>
>> --
>> _______________________________________________
>> Openembedded-core mailing list
>> Openembedded-core@lists.openembedded.org
>> http://lists.openembedded.org/mailman/listinfo/openembedded-core
>>
>

[-- Attachment #2: Type: text/html, Size: 3807 bytes --]

✗ patchtest: failure for doc: drop some incorrect instructions

[Patchwork]

== Series Details ==

Series: doc: drop some incorrect instructions
Revision: 1
URL   : https://patchwork.openembedded.org/series/14919/
State : failure

== Summary ==


Thank you for submitting this patch series to OpenEmbedded Core. This is
an automated response. Several tests have been executed on the proposed
series by patchtest resulting in the following failures:



* Issue             Series sent to the wrong mailing list or some patches from the series correspond to different mailing lists [test_target_mailing_list] 
  Suggested fix    Send the series again to the correct mailing list (ML)
  Suggested ML     yocto@yoctoproject.org [http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/]
  Patch's path:    documentation/ref-manual/ref-classes.xml

* Issue             Series does not apply on top of target branch [test_series_merge_on_head] 
  Suggested fix    Rebase your series on top of targeted branch
  Targeted branch  master (currently at ae12c5f866)



If you believe any of these test results are incorrect, please reply to the
mailing list (openembedded-core@lists.openembedded.org) raising your concerns.
Otherwise we would appreciate you correcting the issues and submitting a new
version of the patchset if applicable. Please ensure you add/increment the
version number when sending the new version (i.e. [PATCH] -> [PATCH v2] ->
[PATCH v3] -> ...).

---
Guidelines:     https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines
Test framework: http://git.yoctoproject.org/cgit/cgit.cgi/patchtest
Test suite:     http://git.yoctoproject.org/cgit/cgit.cgi/patchtest-oe