| Message ID | 20230904102111.472125-1-yoann.congal@smile.fr |
|---|---|
| State | New |
| Headers | show |
| Series | dev-manual: remove unsupported :term: markup inside markup | expand |
Hi Yoann On 04.09.23 at 12:21, Yoann Congal wrote: > ":term:`Initramfs`" in bold text appears verbatim (no link is created). > > The term link is present elsewhere in the text so remove the extra > markup. > > Signed-off-by: Yoann Congal <yoann.congal@smile.fr> > --- > documentation/dev-manual/building.rst | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst > index 1f1642e84..a39579349 100644 > --- a/documentation/dev-manual/building.rst > +++ b/documentation/dev-manual/building.rst > @@ -273,12 +273,12 @@ loading modules needed to locate and mount the final root filesystem. > > Follow these steps to create an :term:`Initramfs` image: > > -#. *Create the :term:`Initramfs` Image Recipe:* You can reference the > +#. *Create the Initramfs Image Recipe:* You can reference the > ``core-image-minimal-initramfs.bb`` recipe found in the > ``meta/recipes-core`` directory of the :term:`Source Directory` > as an example from which to work. > > -#. *Decide if You Need to Bundle the :term:`Initramfs` Image Into the Kernel > +#. *Decide if You Need to Bundle the Initramfs Image Into the Kernel > Image:* If you want the :term:`Initramfs` image that is built to be bundled > in with the kernel image, set the :term:`INITRAMFS_IMAGE_BUNDLE` > variable to ``"1"`` in your ``local.conf`` configuration file and set the Thank you for the patch! Actually, I'd prefer to keep the code as it is. It doesn't hurt as the output is the same, and it makes it easier to look for terms which are not referred to through a ":term:" statement. It's also possible that future versions of Sphinx will create such a link. Cheers Michael.
On 9/5/23 10:21, Michael Opdenacker wrote: > Hi Yoann Hi Michael, > On 04.09.23 at 12:21, Yoann Congal wrote: >> ":term:`Initramfs`" in bold text appears verbatim (no link is created). >> >> The term link is present elsewhere in the text so remove the extra >> markup. >> >> Signed-off-by: Yoann Congal <yoann.congal@smile.fr> >> --- >> documentation/dev-manual/building.rst | 4 ++-- >> 1 file changed, 2 insertions(+), 2 deletions(-) >> >> diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst >> index 1f1642e84..a39579349 100644 >> --- a/documentation/dev-manual/building.rst >> +++ b/documentation/dev-manual/building.rst >> @@ -273,12 +273,12 @@ loading modules needed to locate and mount the final root filesystem. >> Follow these steps to create an :term:`Initramfs` image: >> -#. *Create the :term:`Initramfs` Image Recipe:* You can reference the >> +#. *Create the Initramfs Image Recipe:* You can reference the >> ``core-image-minimal-initramfs.bb`` recipe found in the >> ``meta/recipes-core`` directory of the :term:`Source Directory` >> as an example from which to work. >> -#. *Decide if You Need to Bundle the :term:`Initramfs` Image Into the Kernel >> +#. *Decide if You Need to Bundle the Initramfs Image Into the Kernel >> Image:* If you want the :term:`Initramfs` image that is built to be bundled >> in with the kernel image, set the :term:`INITRAMFS_IMAGE_BUNDLE` >> variable to ``"1"`` in your ``local.conf`` configuration file and set the > > > Thank you for the patch! > Actually, I'd prefer to keep the code as it is. It doesn't hurt as the output is the same, and it makes it easier to look for terms which are not referred to through a ":term:" statement. Maybe I was not clear enough in my message. The output does not stay the same : It goes from ":term:`Initramfs`" (":term:" is visible in the output!). see https://photos.app.goo.gl/KqRnXGy4B5UGi4Wi6 or https://docs.yoctoproject.org/dev/dev-manual/building.html#building-an-initial-ram-filesystem-initramfs-image ... to just "Initramfs". > It's also possible that future versions of Sphinx will create such a link. In any case, feel free to ignore this patch. The choice is yours, I just wanted to be sure you saw the problem I was trying to fix. Regards,
Hi Yoann, On 05.09.23 at 15:34, Yoann Congal wrote: > On 9/5/23 10:21, Michael Opdenacker wrote: >> Hi Yoann > Hi Michael, > >> On 04.09.23 at 12:21, Yoann Congal wrote: >>> ":term:`Initramfs`" in bold text appears verbatim (no link is created). >>> >>> The term link is present elsewhere in the text so remove the extra >>> markup. >>> >>> Signed-off-by: Yoann Congal <yoann.congal@smile.fr> >>> --- >>> documentation/dev-manual/building.rst | 4 ++-- >>> 1 file changed, 2 insertions(+), 2 deletions(-) >>> >>> diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst >>> index 1f1642e84..a39579349 100644 >>> --- a/documentation/dev-manual/building.rst >>> +++ b/documentation/dev-manual/building.rst >>> @@ -273,12 +273,12 @@ loading modules needed to locate and mount the final root filesystem. >>> Follow these steps to create an :term:`Initramfs` image: >>> -#. *Create the :term:`Initramfs` Image Recipe:* You can reference the >>> +#. *Create the Initramfs Image Recipe:* You can reference the >>> ``core-image-minimal-initramfs.bb`` recipe found in the >>> ``meta/recipes-core`` directory of the :term:`Source Directory` >>> as an example from which to work. >>> -#. *Decide if You Need to Bundle the :term:`Initramfs` Image Into the Kernel >>> +#. *Decide if You Need to Bundle the Initramfs Image Into the Kernel >>> Image:* If you want the :term:`Initramfs` image that is built to be bundled >>> in with the kernel image, set the :term:`INITRAMFS_IMAGE_BUNDLE` >>> variable to ``"1"`` in your ``local.conf`` configuration file and set the >> >> Thank you for the patch! >> Actually, I'd prefer to keep the code as it is. It doesn't hurt as the output is the same, and it makes it easier to look for terms which are not referred to through a ":term:" statement. > Maybe I was not clear enough in my message. > > The output does not stay the same : > It goes from ":term:`Initramfs`" (":term:" is visible in the output!). see https://photos.app.goo.gl/KqRnXGy4B5UGi4Wi6 or https://docs.yoctoproject.org/dev/dev-manual/building.html#building-an-initial-ram-filesystem-initramfs-image > ... to just "Initramfs". > Thanks. I see the problem now. I guess I was looking at the wrong lines. Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> ... and merged into "master-next". Thanks again Michael.
diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst index 1f1642e84..a39579349 100644 --- a/documentation/dev-manual/building.rst +++ b/documentation/dev-manual/building.rst @@ -273,12 +273,12 @@ loading modules needed to locate and mount the final root filesystem. Follow these steps to create an :term:`Initramfs` image: -#. *Create the :term:`Initramfs` Image Recipe:* You can reference the +#. *Create the Initramfs Image Recipe:* You can reference the ``core-image-minimal-initramfs.bb`` recipe found in the ``meta/recipes-core`` directory of the :term:`Source Directory` as an example from which to work. -#. *Decide if You Need to Bundle the :term:`Initramfs` Image Into the Kernel +#. *Decide if You Need to Bundle the Initramfs Image Into the Kernel Image:* If you want the :term:`Initramfs` image that is built to be bundled in with the kernel image, set the :term:`INITRAMFS_IMAGE_BUNDLE` variable to ``"1"`` in your ``local.conf`` configuration file and set the
":term:`Initramfs`" in bold text appears verbatim (no link is created). The term link is present elsewhere in the text so remove the extra markup. Signed-off-by: Yoann Congal <yoann.congal@smile.fr> --- documentation/dev-manual/building.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)