From patchwork Mon Aug 1 10:35:26 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 10831 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0ABA5C19F2C for ; Mon, 1 Aug 2022 10:35:48 +0000 (UTC) Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [217.70.183.198]) by mx.groups.io with SMTP id smtpd.web12.23288.1659350146203841883 for ; Mon, 01 Aug 2022 03:35:46 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=none, err=permanent DNS error (domain: 0leil.net, ip: 217.70.183.198, mailfrom: foss+yocto@0leil.net) Received: (Authenticated sender: foss@0leil.net) by mail.gandi.net (Postfix) with ESMTPSA id E0BD3C0009; Mon, 1 Aug 2022 10:35:43 +0000 (UTC) From: Quentin Schulz To: docs@lists.yoctoproject.org Cc: Quentin Schulz , Quentin Schulz Subject: [PATCH 1/4] README: fix Git repository URL Date: Mon, 1 Aug 2022 12:35:26 +0200 Message-Id: <20220801103529.2053164-1-foss+yocto@0leil.net> X-Mailer: git-send-email 2.37.1 MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 01 Aug 2022 10:35:48 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3095 From: Quentin Schulz 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 Signed-off-by: Quentin Schulz --- 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 From patchwork Mon Aug 1 10:35:27 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 10832 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id EA4F3C00144 for ; Mon, 1 Aug 2022 10:35:47 +0000 (UTC) Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [217.70.183.198]) by mx.groups.io with SMTP id smtpd.web12.23289.1659350146670895015 for ; Mon, 01 Aug 2022 03:35:47 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=none, err=permanent DNS error (domain: 0leil.net, ip: 217.70.183.198, mailfrom: foss+yocto@0leil.net) Received: (Authenticated sender: foss@0leil.net) by mail.gandi.net (Postfix) with ESMTPSA id C2A4CC0008; Mon, 1 Aug 2022 10:35:44 +0000 (UTC) From: Quentin Schulz To: docs@lists.yoctoproject.org Cc: Quentin Schulz , Quentin Schulz Subject: [PATCH 2/4] docs: conf.py: update yocto_git base URL Date: Mon, 1 Aug 2022 12:35:27 +0200 Message-Id: <20220801103529.2053164-2-foss+yocto@0leil.net> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220801103529.2053164-1-foss+yocto@0leil.net> References: <20220801103529.2053164-1-foss+yocto@0leil.net> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 01 Aug 2022 10:35:47 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3096 From: Quentin Schulz 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 Signed-off-by: Quentin Schulz --- 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), From patchwork Mon Aug 1 10:35:28 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 10833 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id D67DAC3F6B0 for ; Mon, 1 Aug 2022 10:35:57 +0000 (UTC) Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [217.70.183.198]) by mx.groups.io with SMTP id smtpd.web08.23067.1659350147537799076 for ; Mon, 01 Aug 2022 03:35:47 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=none, err=permanent DNS error (domain: 0leil.net, ip: 217.70.183.198, mailfrom: foss+yocto@0leil.net) Received: (Authenticated sender: foss@0leil.net) by mail.gandi.net (Postfix) with ESMTPSA id 98D66C0007; Mon, 1 Aug 2022 10:35:45 +0000 (UTC) From: Quentin Schulz To: docs@lists.yoctoproject.org Cc: Quentin Schulz , Quentin Schulz Subject: [PATCH 3/4] docs: README: add TeX font package required for building PDF Date: Mon, 1 Aug 2022 12:35:28 +0200 Message-Id: <20220801103529.2053164-3-foss+yocto@0leil.net> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220801103529.2053164-1-foss+yocto@0leil.net> References: <20220801103529.2053164-1-foss+yocto@0leil.net> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 01 Aug 2022 10:35:57 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3097 From: Quentin Schulz 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 Signed-off-by: Quentin Schulz --- 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 From patchwork Mon Aug 1 10:35:29 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 10834 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id D29E0C00144 for ; Mon, 1 Aug 2022 10:35:57 +0000 (UTC) Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [217.70.183.198]) by mx.groups.io with SMTP id smtpd.web10.23024.1659350148555632708 for ; Mon, 01 Aug 2022 03:35:48 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=none, err=permanent DNS error (domain: 0leil.net, ip: 217.70.183.198, mailfrom: foss+yocto@0leil.net) Received: (Authenticated sender: foss@0leil.net) by mail.gandi.net (Postfix) with ESMTPSA id 79664C0011; Mon, 1 Aug 2022 10:35:46 +0000 (UTC) From: Quentin Schulz To: docs@lists.yoctoproject.org Cc: Quentin Schulz , Quentin Schulz Subject: [PATCH 4/4] docs: ref-manual: system-requirements: add missing packages Date: Mon, 1 Aug 2022 12:35:29 +0200 Message-Id: <20220801103529.2053164-4-foss+yocto@0leil.net> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220801103529.2053164-1-foss+yocto@0leil.net> References: <20220801103529.2053164-1-foss+yocto@0leil.net> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 01 Aug 2022 10:35:57 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3098 From: Quentin Schulz 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 Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker --- 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