[PATCH 0/2] Fixups for glossary

[PATCH 0/2] Fixups for glossary

[Daniel Wagenknecht]

Did some fixups as suggested by Quentin.

On Fri, 2021-06-11 at 19:20 +0200, Quentin Schulz wrote:
> >           IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \
> > -             --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \
> > +             --faketime --output=${IMGDEPLOYDIR}/${IMAGE_NAME}.rootfs.jffs2 \
> >               ${EXTRA_IMAGECMD}"
> 
> It'd be awesome if you could do a follow-up patch here since this isn't the actual
> content of this variable anymore.
done

> IMAGE_MANIFEST isn't in this class anymore, it'd be great again if you
> could send a follow-up patch for this.
done

> On a side note: you should have added the term in the glossary (from patch 2)
> first, because technically this commit does not build.
will keep in mind next time.

Thanks for taking a thorough look at the changes and what was still
missing. Great work you are all doing with the documentation!

Best Wishes
  Daniel

Daniel Wagenknecht (2):
  ref-manual: variables: fixup example in IMAGE_CMD
  ref-manual: variables: fixup class reference in IMAGE_MANIFEST

 documentation/ref-manual/variables.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

-- 
2.25.1

[PATCH 1/2] ref-manual: variables: fixup example in IMAGE_CMD

[Daniel Wagenknecht]

The example for IMAGE_CMD_jffs2 given in the glossary for IMAGE_CMD
didn't align with the implementation anymore. Update it to match the
implementation.

Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
---
 documentation/ref-manual/variables.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index ee1043108..1be825fab 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2952,8 +2952,8 @@ system and gives an overview of their function and contents.
       ``btrfs``, and so forth). When setting this variable, you should use
       an override for the associated type. Here is an example::
 
-         IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \
-             --faketime --output=${IMGDEPLOYDIR}/${IMAGE_NAME}.rootfs.jffs2 \
+         IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} --faketime \
+             --output=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.jffs2 \
              ${EXTRA_IMAGECMD}"
 
       You typically do not need to set this variable unless you are adding
-- 
2.25.1

[PATCH 2/2] ref-manual: variables: fixup class reference in IMAGE_MANIFEST

[Daniel Wagenknecht]

The definition of IMAGE_MANIFEST was moved to a different class. Fixup
the documentation to reflect this change.

Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
---
 documentation/ref-manual/variables.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 1be825fab..ff37c9f18 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3099,7 +3099,7 @@ system and gives an overview of their function and contents.
 
           packagename packagearch version
 
-      The :ref:`image <ref-classes-image>` class defines the manifest
+      The :ref:`rootfs-postcommands <ref-classes-rootfs*>` class defines the manifest
       file as follows::
 
          IMAGE_MANIFEST ="${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.manifest"
-- 
2.25.1

Re: [docs] [PATCH 0/2] Fixups for glossary

[Michael Opdenacker]

Hi Daniel,

On 6/14/21 7:30 AM, Daniel Wagenknecht wrote:
> Did some fixups as suggested by Quentin.
>
> On Fri, 2021-06-11 at 19:20 +0200, Quentin Schulz wrote:
>>>           IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \
>>> -             --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \
>>> +             --faketime --output=${IMGDEPLOYDIR}/${IMAGE_NAME}.rootfs.jffs2 \
>>>               ${EXTRA_IMAGECMD}"
>> It'd be awesome if you could do a follow-up patch here since this isn't the actual
>> content of this variable anymore.
> done
>
>> IMAGE_MANIFEST isn't in this class anymore, it'd be great again if you
>> could send a follow-up patch for this.
> done
>
>> On a side note: you should have added the term in the glossary (from patch 2)
>> first, because technically this commit does not build.
> will keep in mind next time.
>
> Thanks for taking a thorough look at the changes and what was still
> missing. Great work you are all doing with the documentation!
>
> Best Wishes
>   Daniel
>
> Daniel Wagenknecht (2):
>   ref-manual: variables: fixup example in IMAGE_CMD
>   ref-manual: variables: fixup class reference in IMAGE_MANIFEST
>
>  documentation/ref-manual/variables.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)


Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Many thanks for these updates! I merged them into the "master-next"
branch of yocto-docs.

Cheers,

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [PATCH 0/2] Fixups for glossary

[Quentin Schulz]

Hi Daniel,

On Mon, Jun 14, 2021 at 07:30:11AM +0200, Daniel Wagenknecht wrote:
> Did some fixups as suggested by Quentin.
> 
> On Fri, 2021-06-11 at 19:20 +0200, Quentin Schulz wrote:
> > >           IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \
> > > -             --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \
> > > +             --faketime --output=${IMGDEPLOYDIR}/${IMAGE_NAME}.rootfs.jffs2 \
> > >               ${EXTRA_IMAGECMD}"
> > 
> > It'd be awesome if you could do a follow-up patch here since this isn't the actual
> > content of this variable anymore.
> done
> 
> > IMAGE_MANIFEST isn't in this class anymore, it'd be great again if you
> > could send a follow-up patch for this.
> done
> 
> > On a side note: you should have added the term in the glossary (from patch 2)
> > first, because technically this commit does not build.
> will keep in mind next time.
> 
> Thanks for taking a thorough look at the changes and what was still
> missing. Great work you are all doing with the documentation!
> 
> Best Wishes
>   Daniel
> 
> Daniel Wagenknecht (2):
>   ref-manual: variables: fixup example in IMAGE_CMD
>   ref-manual: variables: fixup class reference in IMAGE_MANIFEST
> 

Thanks a ton Daniel, much appreciated :)

Looking forward to your next patches :)
Cheers,
Quentin