public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
* [PATCH 0/4] Various docs fixes
@ 2025-12-01  9:55 Antonin Godard
  2025-12-01  9:55 ` [PATCH 1/4] ref-manual/variables.rst: NVD_DB_VERSION: fix default value Antonin Godard
                   ` (4 more replies)
  0 siblings, 5 replies; 6+ messages in thread
From: Antonin Godard @ 2025-12-01  9:55 UTC (permalink / raw)
  To: docs; +Cc: Thomas Petazzoni

Fix obsolete documentation in some places, after receiving reports on
the list.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (4):
      ref-manual/variables.rst: NVD_DB_VERSION: fix default value
      dev-manual/temporary-source-code.rst: fix definition of WORKDIR
      overview-manual/yp-intro.rst: change removed ECOSYSTEM to ABOUT
      overview-manual/yp-intro.rst: link to YP members and participants

 documentation/dev-manual/temporary-source-code.rst | 14 ++++----------
 documentation/overview-manual/yp-intro.rst         |  9 ++++-----
 documentation/ref-manual/variables.rst             |  4 ++--
 3 files changed, 10 insertions(+), 17 deletions(-)
---
base-commit: c9b19880d281be41660306f1f7456b9735c21487
change-id: 20251107-fixes-3e7c3ba76803



^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 1/4] ref-manual/variables.rst: NVD_DB_VERSION: fix default value
  2025-12-01  9:55 [PATCH 0/4] Various docs fixes Antonin Godard
@ 2025-12-01  9:55 ` Antonin Godard
  2025-12-01  9:55 ` [PATCH 2/4] dev-manual/temporary-source-code.rst: fix definition of WORKDIR Antonin Godard
                   ` (3 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: Antonin Godard @ 2025-12-01  9:55 UTC (permalink / raw)
  To: docs; +Cc: Thomas Petazzoni

Value is FKIE since 10580a6d36aa ("cve-check: change the default feed")
in OE-Core.

Reported-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/variables.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 576995355..71fe11b83 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6307,9 +6307,9 @@ system and gives an overview of their function and contents.
       The :term:`NVD_DB_VERSION` variable allows choosing the CVE feed when
       using the :ref:`ref-classes-cve-check` class. It can be one of:
 
-      -  ``NVD2`` (default): the NVD feed with API version 2
-      -  ``FKIE``: the `FKIE-CAD <https://github.com/fkie-cad/nvd-json-data-feeds>`__
+      -  ``FKIE`` (default): the `FKIE-CAD <https://github.com/fkie-cad/nvd-json-data-feeds>`__
          feed reconstruction
+      -  ``NVD2``: the NVD feed with API version 2
       -  ``NVD1``: the NVD JSON feed (deprecated)
 
       In case of a malformed feed name, the ``NVD2`` feed is selected and an

-- 
2.51.0



^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 2/4] dev-manual/temporary-source-code.rst: fix definition of WORKDIR
  2025-12-01  9:55 [PATCH 0/4] Various docs fixes Antonin Godard
  2025-12-01  9:55 ` [PATCH 1/4] ref-manual/variables.rst: NVD_DB_VERSION: fix default value Antonin Godard
@ 2025-12-01  9:55 ` Antonin Godard
  2025-12-01  9:55 ` [PATCH 3/4] overview-manual/yp-intro.rst: change removed ECOSYSTEM to ABOUT Antonin Godard
                   ` (2 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: Antonin Godard @ 2025-12-01  9:55 UTC (permalink / raw)
  To: docs; +Cc: Thomas Petazzoni

Fix the definition of WORKDIR to match OE-Core.
Rename the Source Directory to "project" as part of the transition to
bitbake-setup and the removal of Poky as in "the Poky repository".

Reported-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/dev-manual/temporary-source-code.rst | 14 ++++----------
 1 file changed, 4 insertions(+), 10 deletions(-)

diff --git a/documentation/dev-manual/temporary-source-code.rst b/documentation/dev-manual/temporary-source-code.rst
index 9a7cd0f77..977edbc3f 100644
--- a/documentation/dev-manual/temporary-source-code.rst
+++ b/documentation/dev-manual/temporary-source-code.rst
@@ -43,11 +43,11 @@ In turn, the path to the work directory for the recipe
 (:term:`WORKDIR`) is defined as
 follows::
 
-   ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}
+   ${BASE_WORKDIR}/${MULTIMACH_TARGET_SYS}/${PN}/${PV}
 
 The actual directory depends on several things:
 
--  :term:`TMPDIR`: The top-level build
+-  :term:`BASE_WORKDIR`: The top-level build
    output directory.
 
 -  :term:`MULTIMACH_TARGET_SYS`:
@@ -55,19 +55,13 @@ The actual directory depends on several things:
 
 -  :term:`PN`: The recipe name.
 
--  :term:`EXTENDPE`: The epoch --- if
-   :term:`PE` is not specified, which is
-   usually the case for most recipes, then :term:`EXTENDPE` is blank.
-
 -  :term:`PV`: The recipe version.
 
--  :term:`PR`: The recipe revision.
-
 As an example, assume a Source Directory top-level folder named
-``poky``, a default :term:`Build Directory` at ``poky/build``, and a
+``project``, a default :term:`Build Directory` at ``project/build``, and a
 ``qemux86-poky-linux`` machine target system. Furthermore, suppose your
 recipe is named ``foo_1.3.0.bb``. In this case, the work directory the
 build system uses to build the package would be as follows::
 
-   poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0
+   project/build/tmp/work/qemux86-poky-linux/foo/1.3.0
 

-- 
2.51.0



^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 3/4] overview-manual/yp-intro.rst: change removed ECOSYSTEM to ABOUT
  2025-12-01  9:55 [PATCH 0/4] Various docs fixes Antonin Godard
  2025-12-01  9:55 ` [PATCH 1/4] ref-manual/variables.rst: NVD_DB_VERSION: fix default value Antonin Godard
  2025-12-01  9:55 ` [PATCH 2/4] dev-manual/temporary-source-code.rst: fix definition of WORKDIR Antonin Godard
@ 2025-12-01  9:55 ` Antonin Godard
  2025-12-01  9:55 ` [PATCH 4/4] overview-manual/yp-intro.rst: link to YP members and participants Antonin Godard
  2025-12-16 16:12 ` [PATCH 0/4] Various docs fixes Antonin Godard
  4 siblings, 0 replies; 6+ messages in thread
From: Antonin Godard @ 2025-12-01  9:55 UTC (permalink / raw)
  To: docs; +Cc: Thomas Petazzoni

The ABOUT tab is where the members/participants are listed now.

Reported-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/overview-manual/yp-intro.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index 4e2eedbf5..c724a397b 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -44,7 +44,7 @@ Here are features and advantages of the Yocto Project:
    system, software, and service vendors adopt and support the Yocto
    Project in their products and services. For a look at the Yocto
    Project community and the companies involved with the Yocto Project,
-   see the "COMMUNITY" and "ECOSYSTEM" tabs on the
+   see the "COMMUNITY" and "ABOUT" tabs on the
    :yocto_home:`Yocto Project <>` home page.
 
 -  *Architecture Agnostic:* Yocto Project supports Intel, ARM, MIPS, AMD, PPC,

-- 
2.51.0



^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 4/4] overview-manual/yp-intro.rst: link to YP members and participants
  2025-12-01  9:55 [PATCH 0/4] Various docs fixes Antonin Godard
                   ` (2 preceding siblings ...)
  2025-12-01  9:55 ` [PATCH 3/4] overview-manual/yp-intro.rst: change removed ECOSYSTEM to ABOUT Antonin Godard
@ 2025-12-01  9:55 ` Antonin Godard
  2025-12-16 16:12 ` [PATCH 0/4] Various docs fixes Antonin Godard
  4 siblings, 0 replies; 6+ messages in thread
From: Antonin Godard @ 2025-12-01  9:55 UTC (permalink / raw)
  To: docs; +Cc: Thomas Petazzoni

Instead of a fixed list of commercial vendors, link to existing lists on
the YP website.

Reported-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/overview-manual/yp-intro.rst | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index c724a397b..dc4d5125d 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -62,10 +62,9 @@ Here are features and advantages of the Yocto Project:
    move between architectures without moving to new development
    environments. Additionally, if you have used the Yocto Project to
    create an image or application and you find yourself not able to
-   support it, commercial Linux vendors such as Wind River, Mentor
-   Graphics, Timesys, and ENEA could take it and provide ongoing
-   support. These vendors have offerings that are built using the Yocto
-   Project.
+   support it, commercial Linux vendors listed on :yocto_home:`/members/` and
+   :yocto_home:`/about/participants/` could take it and provide ongoing
+   support.
 
 -  *Flexibility:* Corporations use the Yocto Project many different
    ways. One example is to create an internal Linux distribution as a

-- 
2.51.0



^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH 0/4] Various docs fixes
  2025-12-01  9:55 [PATCH 0/4] Various docs fixes Antonin Godard
                   ` (3 preceding siblings ...)
  2025-12-01  9:55 ` [PATCH 4/4] overview-manual/yp-intro.rst: link to YP members and participants Antonin Godard
@ 2025-12-16 16:12 ` Antonin Godard
  4 siblings, 0 replies; 6+ messages in thread
From: Antonin Godard @ 2025-12-16 16:12 UTC (permalink / raw)
  To: docs, Antonin Godard; +Cc: Thomas Petazzoni


On Mon, 01 Dec 2025 10:55:18 +0100, Antonin Godard wrote:
> Fix obsolete documentation in some places, after receiving reports on
> the list.
> 
> 

Applied, thanks!

[1/4] ref-manual/variables.rst: NVD_DB_VERSION: fix default value
      commit: 238c88a25b2fc0879cd549c1eaf00498dd4b86cc
[2/4] dev-manual/temporary-source-code.rst: fix definition of WORKDIR
      commit: 9cb0e8a94590563491e210b403519ccfbde866e9
[3/4] overview-manual/yp-intro.rst: change removed ECOSYSTEM to ABOUT
      commit: a8a8d810f0505529aaaa90678e03152c8ac0c00b
[4/4] overview-manual/yp-intro.rst: link to YP members and participants
      commit: 9d394db4f88b66500e4d5a2a518d25f08a0c9472

Best regards,
-- 



^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2025-12-16 16:14 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-12-01  9:55 [PATCH 0/4] Various docs fixes Antonin Godard
2025-12-01  9:55 ` [PATCH 1/4] ref-manual/variables.rst: NVD_DB_VERSION: fix default value Antonin Godard
2025-12-01  9:55 ` [PATCH 2/4] dev-manual/temporary-source-code.rst: fix definition of WORKDIR Antonin Godard
2025-12-01  9:55 ` [PATCH 3/4] overview-manual/yp-intro.rst: change removed ECOSYSTEM to ABOUT Antonin Godard
2025-12-01  9:55 ` [PATCH 4/4] overview-manual/yp-intro.rst: link to YP members and participants Antonin Godard
2025-12-16 16:12 ` [PATCH 0/4] Various docs fixes Antonin Godard

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox