diff mbox series

brief-yoctoprojectqs: specify what "recent Ubuntu Linux distribution" is

Message ID 20251125-quick-starting-guide-v1-1-45386c7b678e@cherry.de
State Accepted
Headers show
Series brief-yoctoprojectqs: specify what "recent Ubuntu Linux distribution" is | expand

Commit Message

Quentin Schulz Nov. 25, 2025, 1:49 p.m. UTC 
From: Quentin Schulz <quentin.schulz@cherry.de>

The docs from any release can be read at any moment. The time-specific
"recent" doesn't actually help. The user could be reading the
instructions for kirkstone and try to build on Ubuntu 25.10 as that is
the most recent version. It'll likely fail though.

Instead, point at the list of supported Linux distributions so that they
know which are supported for the version of the docs they are currently
reading.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 documentation/brief-yoctoprojectqs/index.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)


---
base-commit: bcb6a7c8a401ceadf69a4c0c14dbc89f85ffdebe
change-id: 20251125-quick-starting-guide-2374d519ce02

Best regards,

Comments

Antonin Godard Dec. 1, 2025, 8:35 a.m. UTC | #1 
On Tue, 25 Nov 2025 14:49:18 +0100, Quentin Schulz wrote:
> The docs from any release can be read at any moment. The time-specific
> "recent" doesn't actually help. The user could be reading the
> instructions for kirkstone and try to build on Ubuntu 25.10 as that is
> the most recent version. It'll likely fail though.
> 
> Instead, point at the list of supported Linux distributions so that they
> know which are supported for the version of the docs they are currently
> reading.
> 
> [...]

Applied, thanks!

[1/1] brief-yoctoprojectqs: specify what "recent Ubuntu Linux distribution" is
      commit: e1b4c64cec702dd41657002a62dfbacaabca3587

Best regards,
diff mbox series

Patch

diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index 07bb4e1ca..7d94eebcb 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -15,7 +15,9 @@  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
+      :ref:`supported version of Ubuntu Linux distribution<ref-manual/system-requirements:supported linux distributions>`.
+      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