[PATCH] ref-manual/system-requirements.rst: support Arch Linux

[PATCH] ref-manual/system-requirements.rst: support Arch Linux

[Vincent Davis Jr]

Add support for packages need to build
OE system image on Arch Linux.

Signed-off-by: Vincent Davis Jr <vince@underview.tech>
---
 documentation/poky.yaml.in                    |  2 ++
 .../ref-manual/system-requirements.rst        | 19 +++++++++++++++++++
 2 files changed, 21 insertions(+)

diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index cdccf6f3c..fd3c77576 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -40,6 +40,8 @@ CENTOS8_HOST_PACKAGES_ESSENTIAL : "-y epel-release
      socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \
      python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel \
      rpcgen mesa-libGL-devel zstd lz4"
+ARCH_LINUX_HOST_PACKAGES_ESSENTIAL : "base-devel wget curl git diffstat unzip texinfo \
+     python chrpath zip xterm sdl rpcsvc-proto socat cpio inetutils"
 PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml"
 MIN_PYTHON_VERSION : "3.8.0"
 MIN_TAR_VERSION : "1.28"
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 1f9b3b1b5..8d5856a0c 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -55,6 +55,8 @@ distributions:
 
 -  OpenSUSE Leap 15.3
 
+-  Arch Linux
+
 .. note::
 
    -  While the Yocto Project Team attempts to ensure all Yocto Project
@@ -191,6 +193,23 @@ supported AlmaLinux-8 Linux distribution:
       $ sudo dnf install make python3-pip which inkscape texlive-fncychap
       &PIP3_HOST_PACKAGES_DOC;
 
+
+Arch Linux Packages
+-------------------
+
+Here are the required packages by function given a
+supported Arch Linux distribution:
+
+-  *Essentials:* Packages needed to build an image on a headless system::
+
+      $ sudo pacman -S &ARCH_LINUX_HOST_PACKAGES_ESSENTIAL;
+
+-  *Documentation:* Packages needed if you are going to build out the
+   Yocto Project documentation manuals::
+
+      $ sudo pacman -S make python-pip which inkscape texlive-latexextra
+      &PIP3_HOST_PACKAGES_DOC;
+
 .. _system-requirements-buildtools:
 
 Required Git, tar, Python, make and gcc Versions
-- 
2.38.1

Re: [docs] [PATCH] ref-manual/system-requirements.rst: support Arch Linux

[Quentin Schulz]

Hi Vincent,

Thanks for your patch.

I'm afraid this will not be accepted. We usually refuse to advertise 
support for rolling release distributions.

The advertised supported distributions are tested on our autobuilder and 
we don't run ArchLinux there. I would expect we also don't have the 
bandwidth to debug when things break in ArchLinux. Note that we also do 
not specify support for derivatives of Debian or Ubuntu distributions, 
we have seen issues with Pop_OS! in the past for example.

For this to be accepted in the documentation, I believe we'd need 
patches for the autobuilder so that some builds run on an ArchLinux 
server. This probably needs to be discussed (and financially supported?) 
with Michael Halstead our sysadmin. But first and foremost, we would 
need this support to be agreed by maintainer(s), hence why I'm Cc'ing 
Richard on this, who I hope can raise this to the proper board if he 
doesn't veto this.

Considering it's holiday season, please expect some delay, but don't 
hesitate to ping us in a week or two were you to not receive an answer 
meanwhile.

Cheers,
Quentin

Re: [docs] [PATCH] ref-manual/system-requirements.rst: support Arch Linux

[Michael Opdenacker]

Hi Vincent

Thanks for the patch anyway! I was also going to check whether Arch was 
tested by our Autobuilder.

Am 02.01.23 um 11:19 schrieb Quentin Schulz via lists.yoctoproject.org:
> Hi Vincent,
>
> Thanks for your patch.
>
> I'm afraid this will not be accepted. We usually refuse to advertise 
> support for rolling release distributions.
>
> The advertised supported distributions are tested on our autobuilder 
> and we don't run ArchLinux there. I would expect we also don't have 
> the bandwidth to debug when things break in ArchLinux. Note that we 
> also do not specify support for derivatives of Debian or Ubuntu 
> distributions, we have seen issues with Pop_OS! in the past for example.
>
> For this to be accepted in the documentation, I believe we'd need 
> patches for the autobuilder so that some builds run on an ArchLinux 
> server. This probably needs to be discussed (and financially 
> supported?) with Michael Halstead our sysadmin. But first and 
> foremost, we would need this support to be agreed by maintainer(s), 
> hence why I'm Cc'ing Richard on this, who I hope can raise this to the 
> proper board if he doesn't veto this.
>
> Considering it's holiday season, please expect some delay, but don't 
> hesitate to ping us in a week or two were you to not receive an answer 
> meanwhile.


Another idea would be to create a page on our wiki 
(https://wiki.yoctoproject.org/), for people trying to use Yocto on 
distributions which are currently not supported. We could then refer to 
such a page from the documentation, reminding people that there is no 
support commitment. Or something specific to Arch would be to update 
https://wiki.archlinux.org/title/Yocto

Just my two cents.

Cheers
Michael.

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

Re: [docs] [PATCH] ref-manual/system-requirements.rst: support Arch Linux

[Alexander Kanavin]

On Mon, 2 Jan 2023 at 11:30, Michael Opdenacker via
lists.yoctoproject.org
<michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:
> Another idea would be to create a page on our wiki
> (https://wiki.yoctoproject.org/), for people trying to use Yocto on
> distributions which are currently not supported. We could then refer to
> such a page from the documentation, reminding people that there is no
> support commitment. Or something specific to Arch would be to update
> https://wiki.archlinux.org/title/Yocto

Please no. Wikis are a dumpster of outdated information, and this in
particular will quickly become a source of confusion, which is worse
than simply trying to build and dealing with issues as they happen.

Alex

Re: [docs] [PATCH] ref-manual/system-requirements.rst: support Arch Linux

[Alexander Kanavin]

On Mon, 2 Jan 2023 at 11:33, Alexander Kanavin via
lists.yoctoproject.org <alex.kanavin=gmail.com@lists.yoctoproject.org>
wrote:
> Please no. Wikis are a dumpster of outdated information, and this in
> particular will quickly become a source of confusion, which is worse
> than simply trying to build and dealing with issues as they happen.

On second thought, people on distributions not supported directly
should be pointed to buildtools-tarballs of both kinds. But this
should be in the proper documentation.

Alex

Re: [docs] [PATCH] ref-manual/system-requirements.rst: support Arch Linux

[Michael Opdenacker]

Am 02.01.23 um 13:58 schrieb Alexander Kanavin:
> On Mon, 2 Jan 2023 at 11:33, Alexander Kanavin via
> lists.yoctoproject.org <alex.kanavin=gmail.com@lists.yoctoproject.org>
> wrote:
>> Please no. Wikis are a dumpster of outdated information, and this in
>> particular will quickly become a source of confusion, which is worse
>> than simply trying to build and dealing with issues as they happen.
> On second thought, people on distributions not supported directly
> should be pointed to buildtools-tarballs of both kinds. But this
> should be in the proper documentation.


Good idea.
Submitted as https://lists.yoctoproject.org/g/docs/message/3593
Thanks Alex!

Cheers
Michael.

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