linux/poky.git/documentation, branch scarthgap-5.0.10

ref-manual/variables.rst: document INHIBIT_UPDATERCD_BBCLASS

2025-05-27T16:38:57+00:00

Fix [YOCTO #15753] (From yocto-docs rev: 3996388e337377bedc113d072a51fe9d68dd40c6) Signed-off-by: Alper Ak Signed-off-by: Antonin Godard (cherry picked from commit 5f5a406d4acdfcbf655ac014d0d2807056f95291) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

ref-manual/variables.rst: document SSTATE_SKIP_CREATION

2025-05-27T16:38:57+00:00

(From yocto-docs rev: 40045299491087d3f7d269b696ae48d513dae435) Signed-off-by: Etienne Cordonnier Signed-off-by: Antonin Godard (cherry picked from commit 3982720668aafa18c9ed27304d09f896740b1653) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

ref-manual/variables.rst: document INHIBIT_DEFAULT_RUST_DEPS

2025-05-27T16:38:57+00:00

Fix [YOCTO #15755] (From yocto-docs rev: 2eb345ffa74d58d209a6a8deb27b228c37628034) Signed-off-by: Alper Ak Signed-off-by: Antonin Godard (cherry picked from commit fd143a04bab38f6aeec23ec229657b16fcaecdf1) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

conf.py: tweak SearchEnglish to be hyphen-friendly

2025-05-27T16:38:57+00:00

This modifies the default indexer split() and js splitQuery() methods to support searching for words with hyphens. While this might not be an ideal, rock solid, and fully future-proof solution, it allows at least to search for strings inlcuding hyphens, such as 'bitbake-layers', 'send-error-report', or 'oe-core'. Below is a bit more detailed explanation of the two modifications done: 1) The default split regex in the sphinx-doc SearchLanguage base class is: | _word_re = re.compile(r'\w+') which we simply extend to include hyphens '-'. This will result in a searchindex.js that contains words with hyphens, too. 2) The 'searchtool.js' code notes for its splitQuery() implementation: | /** | * Default splitQuery function. Can be overridden in ``sphinx.search`` with a | * custom function per language. | * | * The regular expression works by splitting the string on consecutive characters | * that are not Unicode letters, numbers, underscores, or emoji characters. | * This is the same as ``\W+`` in Python, preserving the surrogate pair area. | */ | if (typeof splitQuery === "undefined") { | var splitQuery = (query) => query | .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) | .filter(term => term) // remove remaining empty strings | } The hook for this is documented in the sphinx-docs 'SearchLanguage' base class. | .. attribute:: js_splitter_code | | Return splitter function of JavaScript version. The function should be | named as ``splitQuery``. And it should take a string and return list of | strings. | | .. versionadded:: 3.0 We use this to define a simplified splitQuery() function with a split argument that splits on empty spaces only. We extend SearchEnglish (which extends SearchLanguage) here to retain the stemmer code and stopwords for English. [YOCTO #14534] (From yocto-docs rev: ce18901b1059746069a0dea8893ba4a357772b51) Signed-off-by: Enrico Jörns Signed-off-by: Antonin Godard (cherry picked from commit d4a98ee19e0cbd6be96923dc72faee143a6b294b) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable

2025-05-27T16:38:57+00:00

This variable specifies the maximum allowed size of the initramfs image in Kbytes. Fixes [YOCTO #15797] CC: Yoann Congal CC: Randy MacLeod CC: Antonin Godard (From yocto-docs rev: 123d1ec8e532751ac416c21e3eaa92fd904e2171) Signed-off-by: Christos Gavros Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit 07bcdddaf71c76cdec186cf0ddd97a47eec54972) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

ref-manual/variables.rst: document the IMAGE_ROOTFS_MAXSIZE variable

2025-05-27T16:38:57+00:00

This variable specifies the maximum allowed size of the generated image in kilobytes. CC: Yoann Congal CC: Randy MacLeod CC: Antonin Godard CC: Quentin Schulz (From yocto-docs rev: d45174d03e1ccd422b9210e3ba1f648d2f6b5173) Signed-off-by: Christos Gavros Signed-off-by: Antonin Godard (cherry picked from commit f3ddc92081363aa7ef7d4fc2c3b918f32f7bda05) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

sphinx-lint: unbalanced inline literal markup

2025-05-27T16:38:57+00:00

Fix as many instances of unbalanced-inline-literals-delimiters as reported by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped up randomly when references contain links to heading which contain literals enclosed in double-back-tics, and not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 0ba5429953dfa0cdc983ed13ddd06351116031c7) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

sphinx-lint: missing space after literal

2025-05-27T16:38:57+00:00

Fix all instances of missing-space-after-literal as reported by 'make sphinx-lint'. (From yocto-docs rev: b562ea5563adc744703b10e0c9a530ed7476d51a) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

sphinx-lint: trailing whitespace

2025-05-27T16:38:57+00:00

Fix all instances of trailing-whitespace as reported by 'make sphinx-lint'. (From yocto-docs rev: d754df8f2084ad45305cfd9c1cf35da727240aa4) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS

2025-05-19T15:32:49+00:00

Fixes [YOCTO #15509] Reviewed-by: Quentin Schulz (From yocto-docs rev: 38706f0e743447da9a39a6369620fa039ab6df3b) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard (cherry picked from commit f1cdecb6da91dbfac59359c83038cb4a4c36ad0a) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman