[PATCH 1/4] README: fix Git repository URL

[PATCH 1/4] README: fix Git repository URL

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/ actually
redirects (301) to https://git.yoctoproject.org/yocto-docs/.

Moreover, git cloning the original URL fails with the following error:
fatal: repository 'https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/' not found
while it works with the newer URL, so let's switch to the newer URL.

Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 README | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README b/README
index 31119905e..85d8d837b 100644
--- a/README
+++ b/README
@@ -28,5 +28,5 @@ $ git config sendemail.to docs@lists.yoctoproject.org
 
 Now you can just do 'git send-email origin/master..' to send all local patches.
 
-Git repository: https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/
+Git repository: https://git.yoctoproject.org/yocto-docs
 Mailing list: docs@lists.yoctoproject.org
-- 
2.37.1

[PATCH 2/4] docs: conf.py: update yocto_git base URL

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

The URLs are actually redirected from
https://git.yoctoproject.org/cgit/cgit.cgi to
https://git.yoctoproject.org so let's save the user a redirection and
use the most up-to-date URL.

Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 documentation/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/conf.py b/documentation/conf.py
index 2a017569f..07a15ce7d 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -98,7 +98,7 @@ extlinks = {
     'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None),
     'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None),
     'yocto_docs': ('https://docs.yoctoproject.org%s', None),
-    'yocto_git': ('https://git.yoctoproject.org/cgit/cgit.cgi%s', None),
+    'yocto_git': ('https://git.yoctoproject.org%s', None),
     'yocto_sstate': ('http://sstate.yoctoproject.org%s', None),
     'oe_home': ('https://www.openembedded.org%s', None),
     'oe_lists': ('https://lists.openembedded.org%s', None),
-- 
2.37.1

[PATCH 3/4] docs: README: add TeX font package required for building PDF

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

The fncychap.sty font needs to be installed on the host in order to be
able to build the PDF version of the docs, so let's mention it in the
README.

Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 documentation/README | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/documentation/README b/documentation/README
index 6f6a8ec84..6333f0496 100644
--- a/documentation/README
+++ b/documentation/README
@@ -129,6 +129,10 @@ Also install the "inkscape" package from your distribution.
 Inkscape is need to convert SVG graphics to PNG (for EPUB
 export) and to PDF (for PDF export).
 
+Additionally install "fncychap.sty" TeX font if you want to build PDFs. Debian
+and Ubuntu have it in "texlive-latex-extra" package while RedHat distributions
+and OpenSUSE have it in "texlive-fncychap" package for example.
+
 To build the documentation locally, run:
 
  $ cd documentation
-- 
2.37.1

[PATCH 4/4] docs: ref-manual: system-requirements: add missing packages

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

inkscape and the package providing fncychap.sty TeX font were missing
from the packages to install to be able to build the documentation, so
let's add them to the list.

Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 documentation/ref-manual/system-requirements.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 6cf88f2a9..310ee4561 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -133,7 +133,7 @@ supported Ubuntu or Debian Linux distribution:
 -  *Documentation:* Packages needed if you are going to build out the
    Yocto Project documentation manuals::
 
-      $ sudo apt install make python3-pip
+      $ sudo apt install make python3-pip inkscape texlive-latex-extra
       &PIP3_HOST_PACKAGES_DOC;
 
    .. note::
@@ -156,7 +156,7 @@ supported Fedora Linux distribution:
 -  *Documentation:* Packages needed if you are going to build out the
    Yocto Project documentation manuals::
 
-      $ sudo dnf install make python3-pip which
+      $ sudo dnf install make python3-pip which inkscape texlive-fncychap
       &PIP3_HOST_PACKAGES_DOC;
 
 openSUSE Packages
@@ -173,7 +173,7 @@ supported openSUSE Linux distribution:
 -  *Documentation:* Packages needed if you are going to build out the
    Yocto Project documentation manuals::
 
-      $ sudo zypper install make python3-pip which
+      $ sudo zypper install make python3-pip which inkscape texlive-fncychap
       &PIP3_HOST_PACKAGES_DOC;
 
 
@@ -201,7 +201,7 @@ supported CentOS-7 Linux distribution:
 -  *Documentation:* Packages needed if you are going to build out the
    Yocto Project documentation manuals::
 
-      $ sudo yum install make python3-pip which
+      $ sudo yum install make python3-pip which inkscape texlive-fncychap
       &PIP3_HOST_PACKAGES_DOC;
 
 CentOS-8 Packages
@@ -231,7 +231,7 @@ supported CentOS-8 Linux distribution:
 -  *Documentation:* Packages needed if you are going to build out the
    Yocto Project documentation manuals::
 
-      $ sudo dnf install make python3-pip which
+      $ sudo dnf install make python3-pip which inkscape texlive-fncychap
       &PIP3_HOST_PACKAGES_DOC;
 
 Required Git, tar, Python, make and gcc Versions
-- 
2.37.1

Re: [docs] [PATCH 4/4] docs: ref-manual: system-requirements: add missing packages

[Michael Opdenacker]

Hi Quentin,

On 8/1/22 12:35, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>
> inkscape and the package providing fncychap.sty TeX font were missing
> from the packages to install to be able to build the documentation, so
> let's add them to the list.
>
> Cc: Quentin Schulz <foss+yocto@0leil.net>
> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> ---
>   documentation/ref-manual/system-requirements.rst | 10 +++++-----
>   1 file changed, 5 insertions(+), 5 deletions(-)


Good catch. Thanks for the updates and patches.
For all 4 patches:
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
... and merged into master-next.


Thanks again!
Michael.

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