| Message ID | 77d4de56-c700-9ae8-f03f-ede89df13e62@crashcourse.ca |
|---|---|
| State | Rejected |
| Headers | show |
| Series | [v2] brief-yoctoprojectqs: shorten and clarify required host packages | expand |
Hi Robert, On 11/19/25 5:55 PM, Robert P. J. Day via lists.yoctoproject.org wrote: > > Rather than refer specifically to Ubuntu and show an example of > installing essential packages, just refer the reader to the page on > supported Linux distributions and leave it at that. > Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Thanks! Quentin
Hi, On Wed Nov 19, 2025 at 5:55 PM CET, Robert P. J. Day wrote: [...] > -Build Host Packages > -=================== > - > -You must install essential host packages on your build host. The > -following command installs the host packages based on an Ubuntu > -distribution: > - > -.. literalinclude:: ../tools/host_packages_scripts/ubuntu_essential.sh > - :language: shell > - > -.. note:: > +Supported Linux Distributions and Required Host Packages > +======================================================== > > - For host package requirements on all supported Linux distributions, > - see the :ref:`ref-manual/system-requirements:required packages for the build host` > - section in the Yocto Project Reference Manual. > +For host package requirements on all supported Linux distributions, > +see the :ref:`ref-manual/system-requirements:required packages for the build host` > +section in the Yocto Project Reference Manual. I think this defeats the purpose of this guide being the "Quick Start Guide". I _think_ most people run Ubuntu when they run Linux, and I believe this is the reason why this was written like so in this section. So for the majority of people reading this section will be enough, and that's the point. Also, the previous section "Compatible Linux Distribution" does mention that not all version are supported. So I think this section is fine as it is. Antonin
Hi Antonin, On 11/24/25 3:55 PM, Antonin Godard via lists.yoctoproject.org wrote: > Hi, > > On Wed Nov 19, 2025 at 5:55 PM CET, Robert P. J. Day wrote: > [...] >> -Build Host Packages >> -=================== >> - >> -You must install essential host packages on your build host. The >> -following command installs the host packages based on an Ubuntu >> -distribution: >> - >> -.. literalinclude:: ../tools/host_packages_scripts/ubuntu_essential.sh >> - :language: shell >> - >> -.. note:: >> +Supported Linux Distributions and Required Host Packages >> +======================================================== >> >> - For host package requirements on all supported Linux distributions, >> - see the :ref:`ref-manual/system-requirements:required packages for the build host` >> - section in the Yocto Project Reference Manual. >> +For host package requirements on all supported Linux distributions, >> +see the :ref:`ref-manual/system-requirements:required packages for the build host` >> +section in the Yocto Project Reference Manual. > > I think this defeats the purpose of this guide being the "Quick Start Guide". I > _think_ most people run Ubuntu when they run Linux, and I believe this is the > reason why this was written like so in this section. > I have no data on this, so /me shrugs. > So for the majority of people reading this section will be enough, and that's The issue is it's not everything that needs to be done according to our documentation. So it's already outdated and not well maintained. If you want to keep having it this way (which is fair, avoiding to go back and forth between the docs when one is reading "quick start" is a good idea), I believe we can simply have an .rst with only Ubuntu instructions that we can include in both ref-manual/system-requirements.rst and brief-yoctoprojectqs/index.rst so that it never is outdated? > the point. Also, the previous section "Compatible Linux Distribution" does > mention that not all version are supported. So I think this section is fine as Not all doesn't specify which ones. "Recent" is relative to time and I will not be able to build Dunfell on a Ubuntu 25.10 even though that is a recent distro and the docs said to use that. I would like to have this "recent" removed or reworded. Something like :ref:`supported version of Ubuntu distribution</ref-manual/system-requirements:supported linux distributions>` Cheers, Quentin
Hi, On Mon Nov 24, 2025 at 4:21 PM CET, Quentin Schulz wrote: > Hi Antonin, > > On 11/24/25 3:55 PM, Antonin Godard via lists.yoctoproject.org wrote: >> Hi, >> >> On Wed Nov 19, 2025 at 5:55 PM CET, Robert P. J. Day wrote: >> [...] >>> -Build Host Packages >>> -=================== >>> - >>> -You must install essential host packages on your build host. The >>> -following command installs the host packages based on an Ubuntu >>> -distribution: >>> - >>> -.. literalinclude:: ../tools/host_packages_scripts/ubuntu_essential.sh >>> - :language: shell >>> - >>> -.. note:: >>> +Supported Linux Distributions and Required Host Packages >>> +======================================================== >>> >>> - For host package requirements on all supported Linux distributions, >>> - see the :ref:`ref-manual/system-requirements:required packages for the build host` >>> - section in the Yocto Project Reference Manual. >>> +For host package requirements on all supported Linux distributions, >>> +see the :ref:`ref-manual/system-requirements:required packages for the build host` >>> +section in the Yocto Project Reference Manual. >> >> I think this defeats the purpose of this guide being the "Quick Start Guide". I >> _think_ most people run Ubuntu when they run Linux, and I believe this is the >> reason why this was written like so in this section. >> > > I have no data on this, so /me shrugs. I know, me neither, but it's a general feeling I get from what I've seen IRL. >> So for the majority of people reading this section will be enough, and that's > > The issue is it's not everything that needs to be done according to our > documentation. So it's already outdated and not well maintained. If you > want to keep having it this way (which is fair, avoiding to go back and > forth between the docs when one is reading "quick start" is a good > idea), I believe we can simply have an .rst with only Ubuntu > instructions that we can include in both > ref-manual/system-requirements.rst and brief-yoctoprojectqs/index.rst so > that it never is outdated? Sure, having a single document for Ubuntu requirements would be an improvement! >> the point. Also, the previous section "Compatible Linux Distribution" does >> mention that not all version are supported. So I think this section is fine as > > Not all doesn't specify which ones. "Recent" is relative to time and I > will not be able to build Dunfell on a Ubuntu 25.10 even though that is > a recent distro and the docs said to use that. I would like to have this > "recent" removed or reworded. Something like > > :ref:`supported version of Ubuntu > distribution</ref-manual/system-requirements:supported linux distributions>` Ack! I agree on removing "recent" too. Thanks, Antonin
Robert, Antonin, On 11/24/25 4:56 PM, Antonin Godard wrote: > Hi, > > On Mon Nov 24, 2025 at 4:21 PM CET, Quentin Schulz wrote: >> Hi Antonin, >> >> On 11/24/25 3:55 PM, Antonin Godard via lists.yoctoproject.org wrote: >>> Hi, >>> >>> On Wed Nov 19, 2025 at 5:55 PM CET, Robert P. J. Day wrote: >>> [...] >>>> -Build Host Packages >>>> -=================== >>>> - >>>> -You must install essential host packages on your build host. The >>>> -following command installs the host packages based on an Ubuntu >>>> -distribution: >>>> - >>>> -.. literalinclude:: ../tools/host_packages_scripts/ubuntu_essential.sh >>>> - :language: shell >>>> - >>>> -.. note:: >>>> +Supported Linux Distributions and Required Host Packages >>>> +======================================================== >>>> >>>> - For host package requirements on all supported Linux distributions, >>>> - see the :ref:`ref-manual/system-requirements:required packages for the build host` >>>> - section in the Yocto Project Reference Manual. >>>> +For host package requirements on all supported Linux distributions, >>>> +see the :ref:`ref-manual/system-requirements:required packages for the build host` >>>> +section in the Yocto Project Reference Manual. >>> >>> I think this defeats the purpose of this guide being the "Quick Start Guide". I >>> _think_ most people run Ubuntu when they run Linux, and I believe this is the >>> reason why this was written like so in this section. >>> >> >> I have no data on this, so /me shrugs. > > I know, me neither, but it's a general feeling I get from what I've seen IRL. > >>> So for the majority of people reading this section will be enough, and that's >> >> The issue is it's not everything that needs to be done according to our >> documentation. So it's already outdated and not well maintained. If you >> want to keep having it this way (which is fair, avoiding to go back and >> forth between the docs when one is reading "quick start" is a good >> idea), I believe we can simply have an .rst with only Ubuntu >> instructions that we can include in both >> ref-manual/system-requirements.rst and brief-yoctoprojectqs/index.rst so >> that it never is outdated? > > Sure, having a single document for Ubuntu requirements would be an improvement! > Will try giving that a shot except if Robert wants to do it? >>> the point. Also, the previous section "Compatible Linux Distribution" does >>> mention that not all version are supported. So I think this section is fine as >> >> Not all doesn't specify which ones. "Recent" is relative to time and I >> will not be able to build Dunfell on a Ubuntu 25.10 even though that is >> a recent distro and the docs said to use that. I would like to have this >> "recent" removed or reworded. Something like >> >> :ref:`supported version of Ubuntu >> distribution</ref-manual/system-requirements:supported linux distributions>` > > Ack! I agree on removing "recent" too. > Robert, do you want to send a v3 with this or do you mind if I take over the patch? Quentin
On Tue, 25 Nov 2025, Quentin Schulz wrote: > Robert, Antonin, > > On 11/24/25 4:56 PM, Antonin Godard wrote: > > Hi, > > > > On Mon Nov 24, 2025 at 4:21 PM CET, Quentin Schulz wrote: > > > Hi Antonin, > > > > > > On 11/24/25 3:55 PM, Antonin Godard via lists.yoctoproject.org wrote: > > > > Hi, > > > > > > > > On Wed Nov 19, 2025 at 5:55 PM CET, Robert P. J. Day wrote: > > > > [...] > > > > > -Build Host Packages > > > > > -=================== > > > > > - > > > > > -You must install essential host packages on your build host. The > > > > > -following command installs the host packages based on an Ubuntu > > > > > -distribution: > > > > > - > > > > > -.. literalinclude:: > > > > > ../tools/host_packages_scripts/ubuntu_essential.sh > > > > > - :language: shell > > > > > - > > > > > -.. note:: > > > > > +Supported Linux Distributions and Required Host Packages > > > > > +======================================================== > > > > > > > > > > - For host package requirements on all supported Linux > > > > > distributions, > > > > > - see the :ref:`ref-manual/system-requirements:required packages for > > > > > the build host` > > > > > - section in the Yocto Project Reference Manual. > > > > > +For host package requirements on all supported Linux distributions, > > > > > +see the :ref:`ref-manual/system-requirements:required packages for > > > > > the build host` > > > > > +section in the Yocto Project Reference Manual. > > > > > > > > I think this defeats the purpose of this guide being the "Quick Start > > > > Guide". I > > > > _think_ most people run Ubuntu when they run Linux, and I believe this > > > > is the > > > > reason why this was written like so in this section. > > > > > > > > > > I have no data on this, so /me shrugs. > > > > I know, me neither, but it's a general feeling I get from what I've seen > > IRL. > > > > > > So for the majority of people reading this section will be enough, and > > > > that's > > > > > > The issue is it's not everything that needs to be done according to our > > > documentation. So it's already outdated and not well maintained. If you > > > want to keep having it this way (which is fair, avoiding to go back and > > > forth between the docs when one is reading "quick start" is a good > > > idea), I believe we can simply have an .rst with only Ubuntu > > > instructions that we can include in both > > > ref-manual/system-requirements.rst and brief-yoctoprojectqs/index.rst so > > > that it never is outdated? > > > > Sure, having a single document for Ubuntu requirements would be an > > improvement! > > > > Will try giving that a shot except if Robert wants to do it? > > > > > the point. Also, the previous section "Compatible Linux Distribution" > > > > does > > > > mention that not all version are supported. So I think this section is > > > > fine as > > > > > > Not all doesn't specify which ones. "Recent" is relative to time and I > > > will not be able to build Dunfell on a Ubuntu 25.10 even though that is > > > a recent distro and the docs said to use that. I would like to have this > > > "recent" removed or reworded. Something like > > > > > > :ref:`supported version of Ubuntu > > > distribution</ref-manual/system-requirements:supported linux > > > distributions>` > > > > Ack! I agree on removing "recent" too. > > > > Robert, do you want to send a v3 with this or do you mind if I take over the > patch? It's all yours, I'll move on to nitpicking other stuff. Thanks. rday
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 07bb4e1ca..76b72e9b5 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst @@ -15,7 +15,7 @@ build a reference embedded OS called Poky. .. note:: - The examples in this paper assume you are using a native Linux - system running a recent Ubuntu Linux distribution. If the machine + system running a supported Linux distribution. If the machine you want to use Yocto Project on to build an image (:term:`Build Host`) is not a native Linux system, you can still perform these steps by using @@ -71,21 +71,12 @@ can still use the Yocto Project. See the :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` section in the Yocto Project Reference Manual for information. -Build Host Packages -=================== - -You must install essential host packages on your build host. The -following command installs the host packages based on an Ubuntu -distribution: - -.. literalinclude:: ../tools/host_packages_scripts/ubuntu_essential.sh - :language: shell - -.. note:: +Supported Linux Distributions and Required Host Packages +======================================================== - For host package requirements on all supported Linux distributions, - see the :ref:`ref-manual/system-requirements:required packages for the build host` - section in the Yocto Project Reference Manual. +For host package requirements on all supported Linux distributions, +see the :ref:`ref-manual/system-requirements:required packages for the build host` +section in the Yocto Project Reference Manual. Use Git to Clone bitbake-setup ==============================
Rather than refer specifically to Ubuntu and show an example of installing essential packages, just refer the reader to the page on supported Linux distributions and leave it at that. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> ---