Commit Graph

6897 Commits

Author SHA1 Message Date
Marco Cavallini
a1ed615a2d dev-manual/start.rst: added missing command in Optimize your VHDX file using DiskPart
After compact vsdisk you have to detach it before exiting
  otherwise the vdisk remains attached.

  DISKPART> select vdisk file="<path_to_VHDX_file>"
  DISKPART> attach vdisk readonly
  DISKPART> compact vdisk
  DISKPART> detach     <------------ new missing command
  DISKPART> exit

(From yocto-docs rev: 1cc65ddf1a074f61fe5a63d222f3079b7fcb4c1e)

Signed-off-by: Marco Cavallini <m.cavallini@koansoftware.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-08-01 11:59:18 +01:00
Antonin Godard
6e5d021cd6 dev-manual/start.rst: remove basic setup for hash equivalence
Quoting Alexander Kanavin [1]:

> 1. BB_HASHSERVE and BB_SIGNATURE_HANDLER do not set up or start a
> server, they set up the hash equivalence client built into bitbake.
>
> 2. The above client configuration (used by poky) also starts a private
> server that is specific to a particular build directory. So hash equiv
> information would not be shared between multiple build directories,
> and this will cause sstate mismatches (as reported in the bug), if
> sstate is shared.

This setup does not shed light on the potential of the hash equivalence
feature. So for now, remove this basic setup, and later rework the
concepts (or create a new) document that explains how to set up a hash
equivalence server shared between builds.

[1]: https://lore.kernel.org/r/CANNYZj_kvLsZG3sgH+nPu9B=pqWBU785w0SGHGdQqB4UW-DtmA@mail.gmail.com

Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com>
(From yocto-docs rev: 231fc9e710ab34db60263f8ae01d4f5970579203)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-08-01 11:59:18 +01:00
Antonin Godard
853f8bfbb8 dev-manual/start.rst: remove shared PERSISTENT_DIR mentions
Remove the shared PERSISTENT_DIR mention introduced by 3954eda78f22
("dev-manual/start.rst: mention that PERSISTENT_DIR should be shared
too"), as it should _not_ be shared.

Instead recommend setting up a hash equivalence server.

(From yocto-docs rev: f9f1c87424d307d2df60024bc448bd6778605cf8)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-15 13:57:32 +01:00
Antonin Godard
818d405494 ref-manual/structure.rst: remove shared PERSISTENT_DIR mentions
PERSISTENT_DIR should _not_ be shared, I got that wrong in my previous
commit 741aa29898dc ("ref-manual/structure.rst: update with info on
PERSISTENT_DIR"). Remove these mentions.

(From yocto-docs rev: 4c7fc7a6e9b0b957bcf0deb66adb0a6d9ebead00)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-15 13:57:32 +01:00
Antonin Godard
217d5b3c3c overview-manual/concepts.rst: fix sayhello hardcoded bindir
Replace the hardcoded /usr/bin by ${bindir}, as it should be.

Reported-by: Thomas Perrot <thomas.perrot@bootlin.com>
(From yocto-docs rev: 576677eae6960dbc2d2ececeba0fde5bba7bb69f)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-11 13:30:44 +01:00
Antonin Godard
d4a065a7e8 overview-manual/concepts.rst: mention PERSISTENT_DIR for user configuration
The PERSISTENT_DIR directory can also be customized to be shared, so
mention it in the list of configuration variables in local.conf.

(From yocto-docs rev: f3aa0e8f0d15f036b65253c1e0036eb7e1e16088)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-11 13:30:44 +01:00
Antonin Godard
1eab7980ae dev-manual/start.rst: mention that PERSISTENT_DIR should be shared too
In the "Development environment summary", we mention that the shared
state dir can be shared for developers, but PERSISTENT_DIR should be
shared as well, otherwise bugs described in [1] can happen.

[1]: https://bugzilla.yoctoproject.org/show_bug.cgi?id=15921

[YOCTO #15921]

(From yocto-docs rev: 3954eda78f22f205cbd31857f5b0992900fe7b02)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-11 13:30:44 +01:00
Antonin Godard
e790ad0f3e ref-manual/structure.rst: update with info on PERSISTENT_DIR
Since we mention that SSTATE_DIR can be shared for multiple builds, also
mention that PERSISTENT_DIR should be shared alongside SSTATE_DIR.

[YOCTO #15921]

(From yocto-docs rev: 741aa29898dc7f34ebd423ff7565334b2c89e18c)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-11 13:30:44 +01:00
Antonin Godard
cbbac30edb test-manual/understand-autobuilder.rst: mention hashequiv server
The autobuilder also uses a shared Hash Equivalence server, so mention
it here too.

(From yocto-docs rev: a96640f98c91f147e05cf132efab114b1e7dc8eb)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-11 13:30:44 +01:00
Antonin Godard
aaf748b28c poky.yaml.in: increase minimum RAM from 8 to 32
In the light of the recent LLVM addition, and other such heavier
recipes, increase the minimum RAM requirement from 8Gb to 32Gb.

(From yocto-docs rev: 3055affc8a37a40d03206140e47caf3d1437ec35)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-11 13:30:44 +01:00
Lee Chee Yang
8542be1726 migration-guides: add release notes for 4.0.28
(From yocto-docs rev: 6959193fddb039c34384fcc391195fdd7fd3dbb8)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-11 13:30:44 +01:00
Antonin Godard
b578190fb4 ref-manual/variables.rst: make reference to new limiting-resources doc
For host resource limiting variables, make a reference to the new
"Limiting the Host Resources Usage" document.

(From yocto-docs rev: 161a8549441e8c38791ab7f63001b2a15a39d2f2)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-11 13:30:44 +01:00
Antonin Godard
919d227323 Add a document on limiting host resources
Add a "Limiting the Host Resources Usage" document to share the
different techniques that can be used to limit the host resources usage.
We do have a document to document how to speed up a build, so this
document comes right after.

[YOCTO #15111]

(From yocto-docs rev: 584b8b30cd884ff6c62efcff9e9b566476a84589)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-11 13:30:44 +01:00
Enrico Jörns
b1acce1955 conf.py: improve SearchEnglish to handle terms with dots
While search queries already handled words with hyphens correctly, they
did not do so for words with dots.

To fix this, we

- enhance the word tokenizer to treat both dots ('.') and hyphens ('-')
  as valid characters within words.
  (For robustness, explicitly exclude dots/hyphens at the start or end
  of a word from indexing.)
- adjust query processing to avoid splitting on dots in search input

This allows search queries to correctly match terms such as
'local.conf', 'site.conf', and similar ones now.

Fixes: [YOCTO #14534]

(From yocto-docs rev: 80084a4cabdf7f61c7e93eda8ddbd5bc7d54e041)

Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-04 22:48:21 +01:00
Bo Sun
eab29e5b54 bsp-guide: fix branch listing command
Replace 'git branch -al' with 'git branch -a' to correctly show both
local and remote branches. The '-l' option is unnecessary and may cause
confusion.

(From yocto-docs rev: 46aa3bb398c50af0f29acd2c1a05ee232d0de5b9)

Signed-off-by: Bo Sun <bo@mboxify.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-04 22:48:21 +01:00
Bo Sun
d028bde750 bsp-guide: fix README link for meta-intel layer
Update the meta-intel BSP layer reference to point to README.md
instead of README, reflecting the actual file name in the repository.

(From yocto-docs rev: 32eb132ad69a0722e0075404f809bfe9df06adee)

Signed-off-by: Bo Sun <bo@mboxify.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-04 22:48:21 +01:00
Lee Chee Yang
540f09ad91 ref-manual/yocto-project-supported-features: update contact for meta-intel
(From yocto-docs rev: 083f4c60128d16756c78f61c4cade49e11764034)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-04 22:48:21 +01:00
Ross Burton
c2a375b1fa ref-manual: classes: add recipe-naming QA test
Add documentation for the new recipe-naming recipe QA test.

(From yocto-docs rev: 8f9ad9681c18412e9eedc014e686b1b72e458687)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-07-04 22:48:21 +01:00
Robert P. J. Day
9a6cf0d455 dev-manual: update list of recipe files showing version numbers
Update the short list of recipe files showing examples of proper
naming, and replace obsolete "irssi" example with example using "_git"
as a version.

(From yocto-docs rev: 95691fa4e7d30ee27cb1280df20751bf449538a4)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
3be97486e3 dev-manual: simplify recipe names to use "oe_git" links
Shorten a small number of cumbersome recipe names by replacing them
with :oe_git: markup to link to their repositories.

(From yocto-docs rev: bdcc97d4d605c3de9682b9cb055c253547397f13)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Adrian Freihofer
c9f2036a56 ref-manual/yocto-project-supported-features: add ppc maintainers
PowerPC (32-bit) remains relevant for our use cases, and we aim to
maintain support as long as it is feasible with reasonable effort.

For transparency, our primary focus is on maintaining
core-image-minimal. Support for more complex images may be limited
unless additional contributors join, as ongoing testing and maintenance
of these images may not be feasible otherwise.

(From yocto-docs rev: 63f0053f0f0201529bfad3e3f1b0211ac40ad1c2)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Alexander Kanavin
c6d279acfa migration-guides/migration-5.3.rst: add guidance for breaking WORKDIR changes
(From yocto-docs rev: f59504d8706a817e0b5a6235ebb69cb3b3ebb277)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Antonin Godard
7367292190 ref-manual/variables.rst: document BB_GIT_DEFAULT_DESTSUFFIX
Recently added in BitBake with 378db0fdd95f ("fetch2/git: allow
overriding default unpack directory with a variable").

(From yocto-docs rev: c696f78107a4e0a26329faad11212eb7949e0c70)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
f9277f9694 dev-manual: fix rendering of ${PN}
Current markup generates italic, not monospaced.

(From yocto-docs rev: 859ba2ea1014c351a43a59c481c4498d79f30139)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
5b261b188f dev-manual: correct statements that source is always tarballs
Correct two occurrences that imply source is always fetched as
tarballs.

(From yocto-docs rev: 57490852e6446672fd2cd0f3ee0befd9714c909f)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
c11621b39b dev-manual: show bin_package example wireless-regdb recipe
Add a snippet from the wireless-regdb recipe to demonstrate a simple
example of a bin_package recipe.

(From yocto-docs rev: cbe3e272965cb706a73de36af01e1e0c65ea4efa)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
2e386aea79 dev-manual: fix broken rendering of bullet point
Tweak the formatting of the bullet point title so that it renders both
the term and the bolding properly.

(From yocto-docs rev: 68068c5ab4f4c46c57bc055bd663f8e66096dd20)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
a9f3aa89b3 dev-manual: replace "on the contrary" with "by contrast"
The qualifier "By contrast" is more appropriate here, since that
phrase is used to introduce a point that is strikingly different from
what was just discussed, that being the substantial systemd.

(From yocto-docs rev: 3e73c7985dceb865e648f86ccd82aa0e7fc6668e)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
976f8fceb4 dev-manual: shorten bitbake.conf snippet related to static libs
Much of the reproduced bitbake.conf has nothing to do with showing how
the ${PN}-staticdev is defined, so delete most of it.

(From yocto-docs rev: e235ae40db8f4e7088b2e99e678cdf31b5e216c8)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
034a6278ce dev manual, CH 3: update code snippets to be more current
Nothing major, just copy-and-paste from master branch to replace aging
code examples, and a little grammmar cleanup.

(From yocto-docs rev: 74057a1ffd682754e81f5f7fbde9f233e14a0d00)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
06595cf590 dev-manual: CH 2, small number of clarifications
- drop reference to "opkg", just refer in general to packagers
  - correct what "QEMU" stands for (missing space)
  - correct version conditional
  - add a couple extra steps to typical workflow
  - drop implication that one can modify local poky checkout

(From yocto-docs rev: 4fea81e42c41fc42548dd9e2b42f836daba5ac6b)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
d06769ae03 dev-manual: correct misspelled reference to sstate-cache-management.py
(From yocto-docs rev: 3728eea352f8b326ff411aa0f20bfd433ccc7cfa)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
f36b7525bb dev-manual: minor grammar correction
(From yocto-docs rev: 4e06c7f08a36c54a7f14760e609058468fab112f)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Alexander Kanavin
3b41841b27 migration-guides/migration-5.1.rst: correct S/UNPACKDIR patterns for file-only recipes
It is not necessary to set both; just setting S to UNPACKDIR is enough.

This has already been done across oe-core master, and correct advice
should be given for those who need to adjust recipes during migration.

(From yocto-docs rev: e69144a2420cf412ff62a394583acc3f82413c69)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Alexander Kanavin
73ecebe8a6 ref-manual: correct references to WORKDIR to account for recent do_unpack changes
(From yocto-docs rev: 2e83260484c102fe7b788585cbdd7ca91ba91d85)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Alexander Kanavin
5ebf08ad8d overview-manual: correct the bitbake tasks map section and diagram to account for sources in UNPACKDIR
(From yocto-docs rev: 52a6a642b56beb3dcf22de5ff9568f50ac138500)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Alexander Kanavin
1180a5b591 dev-manual: replace WORKDIR with UNPACKDIR where appropriate
(From yocto-docs rev: 25ea8e2a0428b6cb66402283e64144d5ce61daf6)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Alexander Kanavin
f4447244f5 ref-manual: drop a sentence about a 'legacy way' to specify UNPACKDIR
This wasn't specific, and is obsolete: UNPACKDIR should not be
set by recipes at all, except in very special circumstances
(e.g. gcc/clang unpacking into work-shared).

(From yocto-docs rev: a880d94d70c7ed1da8e40a02dae43ff1699941a6)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Alexander Kanavin
75d8886ac2 overview-manual: correct value of UNPACKDIR and put S under it
(From yocto-docs rev: ec38f3c5a51887175a2cf3397c07c13c17ca2e9d)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Dixit Parmar
d3d8d21fef ref-manual: document KERNEL_SPLIT_MODULES variable
This variable controls the kernel module spliting.

[YOCTO #15771]

(From yocto-docs rev: 198179d9c6231b5934d4fb6ede716d1dcb1442bb)

Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Anibal Limon
a904fe5a03 test-manual/ptest: Add info about fail state of ptest-runner/ptests
On the ML was pointed about no specific information about
ptest-runner/ptests so improve docs around.

https://lists.yoctoproject.org/g/yocto-patches/message/1622

[YOCTO #15832]

(From yocto-docs rev: 0d1fd79019883f366d796b58a01679297d7a5508)

Signed-off-by: Anibal Limon <anibal@limonsoftware.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Richard Purdie
60e8db8588 ref-manual/yocto-project-supported-features: Set riscv32 maintainers as TBD
This isn't committed to by anyone at this point to mark as TBD.

(From yocto-docs rev: 6b45207c8db40ef416f12348e066601975a0ca36)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-24 11:29:26 +01:00
Richard Purdie
5e22c4e351 ref-manual/yocto-project-supported-features: Update to match current status
A few items were in the wrong sections or needed clarification, tweak accordinly.

(From yocto-docs rev: 85e58c4fc5d1be9a2ea9ed6b813d0168e3162dab)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 14:28:27 +01:00
Daniel Turull
63fb85ec37 Add SPDX_INCLUDE_COMPILED_SOURCES documentation
Adding documentation for the new feature to store in SPDX
only the compiled sources.

Merged in oe-core: c6a2f1fca76fae4c3ea471a0c63d0b453beea968
 - spdx: add option to include only compiled sources

CC: Antonin Godard <antonin.godard@bootlin.com>
(From yocto-docs rev: 4dbc63ed1381fe47723d6ba5b7baf2a3b7fd19aa)

Signed-off-by: Daniel Turull <daniel.turull@ericsson.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Robert P. J. Day
7d68886200 bsp-guide: update all of section 1.8.2 to reflect current beaglebone conf file
(From yocto-docs rev: 5fc7794e9ae326eead16552726d74ea801fe535b)

Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Robert P. J. Day
c6be4ac032 bsp-guide: update lonely "4.12" kernel reference to "6.12"
To accompany earlier updating of kernel version, update this lonely
reference to be consistent.

(From yocto-docs rev: e26c2018cd663de91ee08e0cba55eda1a4c30210)

Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Quentin Schulz
e60c9d753c document how to use :doc: directive
Let's specify that we are only expecting "absolute" paths in the docs
directive for local document referencing.

(From yocto-docs rev: 2729250bf1068814e5106d1e71796e8a505963d7)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Quentin Schulz
bebe66feae tree-wide: make the :doc: directive use absolute paths
This makes all :doc: directives use an absolute paths (with the root
directory being documentation/ in the repo).

This is then consistent across the whole source and is easier to review
and move files around, you just need to know where a file is located
relative to documentation/ directory and use that.

This gets rid of paths looking in parent directory with '..' as well as
expecting a file to be in the same directory as the other file it points
to via the :doc: directive.

(From yocto-docs rev: b9457f2005b0bea49c54e9727eb30e9458084886)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Robert P. J. Day
931db3845c bsp guide: update kernel version example to 6.12
Change the sample kernel version being used from 4.4 to a more modern
6.12.

(From yocto-docs rev: 1bad12b6ccfe1c0d26918926176a0c743568de26)

Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Robert P. J. Day
a55b16b5c1 yp-intro: new doc reference is missing leading slash
The new ":doc:" reference for yocto-project-supported-features appears
to be missing a leading slash, causing HTML generation to fail.

(From yocto-docs rev: 4114399711ff82893a10c9eba0ff66c9af7b1c9e)

Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00