summaryrefslogtreecommitdiffstats
path: root/documentation/brief-yoctoprojectqs/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* Clean up explanation of minimum required version numbersRobert P. J. Day2025-06-061-2/+2
| | | | | | | | | | | Some simple rendering and grammar fixes. (From yocto-docs rev: 9a9624bfc4c523a6edf6f3f0c336e663cc939e75) 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>
* brief-yoctoprojectqs/ref-manual: Switch to new CDNRichard Purdie2025-05-291-1/+1
| | | | | | | | | The project is switching the way handle our CDN provision of sstate objects, update the URL accordingly. (From yocto-docs rev: 406e8a8e30404c0538f5aa46f211540bae2b206b) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs/index.rst: replace removed macroAntonin Godard2025-05-261-2/+3
| | | | | | | | | | | | The UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL macro was removed after 8d993022c2ae ("docs: use literalinclude for system requirements"). Replace by the literalinclude like in the reference manual. Reported-by: "Robert P. J. Day" <rpjday@crashcourse.ca> (From yocto-docs rev: 1316bd95f4c4107549de34b78bca0499233497e8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-05-261-1/+1
| | | | | | | | | | | | | | | | 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 a heading which contain literals enclosed in double-back-tics; especially in the cases where a heading either contains multiple literals or when the literal is not at the end of the heading. Not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 3460177c46d360b0f2f852cdab23f21bd4ec6d5a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: remove repeated wordAndrew Kreimer2025-04-211-1/+1
| | | | | | | | | | The word "modern" appears twice, remove the extra one. (From yocto-docs rev: 8a2169431551ea29bf45b2eb120a13f0e444e1ea) Signed-off-by: Andrew Kreimer <algonell@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Gather dependencies in poky.yaml.inAntonin Godard2024-12-161-1/+1
| | | | | | | | | | | | | | | | | We used to have packages here and there in system-requirements.rst for each distro. Instead, gather all the dependencies in poky.yaml.in so we have an overview of what we provide for each distro. Use yaml ">" to list the dependencies in alphabetical order, one entry per line, which makes them easier to read and compare among distros. Rename UBUNTU_… variables to UBUNTU_DEBIAN_…, since these are used for both distros. (From yocto-docs rev: 1ed6118b7cf1b5dcbfca753c83fa30fb97bf44ad) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: brief-yoctoprojectqs: explicit version dependency on websockets python ↵Quentin Schulz2024-05-091-2/+5
| | | | | | | | | | | | | | | | | | module We now check that the websockets module version is at least 9.1 in bitbake itself so we can specify more precisely what "recent version" means. While at it, list which distributions have a recent enough websockets python module in their package feed and give some hint at how to support other distributions. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 9a14157c4d723da0970cfd4bbb2c9500d3e692e0) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Update to the correct hash equivalence server addressRichard Purdie2024-05-021-1/+4
| | | | | | | | Also add a note about needing python websockets installed. (From yocto-docs rev: 9c7869b95b1784f58f0a31f7c015ad3e15af34e1) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: brief-yoctoprojectqs: align variable order with default local.confSimone Weiß2023-12-181-2/+2
| | | | | | | | | | | | Align the order from `BB_SIGNATURE_HANDLER` to `SSTATE_MIRRORS` in Quick Build with the order in the default local conf. While trivial it is easier to find, if the order matches. (From yocto-docs rev: d4a836d1ea2b97c81f7edb4dc234b4a1bd532766) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: use new CDN mirror for sstateMichael Opdenacker2023-10-201-1/+1
| | | | | | | | | | | Recommended instead of the Yocto Project mirror, because expected to be faster. Make sure you only set one such mirror. (From yocto-docs rev: 5a2d09501ab807a0f61c10533f3bd81894f6f20e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: richard.purdie@linuxfoundation.org Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add minimum RAM requirementsMichael Opdenacker2023-04-031-0/+4
| | | | | | | | | | | | Measured by generating a "core-image-sato" image for a "qemux86-64" machine from an Ubuntu 22.04 VM with 4 cores. Less memory was not enough and caused Out of Memory failures. (From yocto-docs rev: a05f87929eed43cef673a8c2581899a8c9ccf462) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: update disk space requirementsMichael Opdenacker2023-04-031-1/+3
| | | | | | | | | | | Tests made on Poky master on March 16, 2023. Add a "Free Disk Space" section to the "System Requirements" document. (From yocto-docs rev: 285ba689ce3ab7b7fdb4bb0d0284e2a52ad62c7f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: system-requirements.rst: simplify supported distro requirementsMichael Opdenacker2023-03-201-4/+2
| | | | | | | | | | | | | | | | | | - This allows to continue sharing the updated Ubuntu/Debian requirements with the brief-yoctoprojectqs/index.rst without indentation mismatches (caused by using the same macro in two different contexts: in direct text and in a bullet list). - Update poky.yaml.in to adapt the number of spaces at the beginning of lines. - brief-yoctoprojectqs/index.rst: fix bad number of spaces before quote block. (From yocto-docs rev: 38a3228f8981674bc75de135246c4f9eff7b43a1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify references to the BitBake User ManualMichael Opdenacker2023-03-201-1/+1
| | | | | | | | | | | | | | | | | | | | - Replacing :ref:`bitbake:bitbake-user-manual/...` by :ref:`bitbake-user-manual/...` Adding "bitbake:" as a prefix is not necessary as there is no naming conflict between the YP and the BitBake manuals (all documents are in "bitbake-user-manual/") - Explaining the rules in the README file - When necessary, fixing line length in the modified paragraphs. (From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: split dev-manual/common-tasks.rstMichael Opdenacker2022-12-011-2/+2
| | | | | | | | | | | | | | A 500 KB source file is always harder to manage, and can have section title conflicts. So, the "Common Tasks" document is gone and all its constituents are moved up one level. You now have 40 chapters in the Development Tasks Manual. (From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: use references to the "Build Directory" termMichael Opdenacker2022-10-281-7/+5
| | | | | | | | | | | | | | Replace instances of "Build Directory" and "build directory" (when applicable) by :term:`Build Directory` as already done in most places. Doing this, fix the indentation of the paragraphs with this term. (From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: updates for building on Windows (WSL 2)Michael Opdenacker2022-10-251-12/+5
| | | | | | | | | | | | | - Use the Wikipedia naming scheme: WSL 2 instead of WSLv2 - Take into account Windows Server 2019 and 2022 which are supported too. - Improve some explanations (From yocto-docs rev: 35c5fb01d3543ef5e1f4edf337a2ab080b4e7956) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: BB_HASHSERVE_UPSTREAM: update to new hostMichael Opdenacker2022-07-201-1/+1
| | | | | | | (From yocto-docs rev: 5004957d1c65d03d3e296bc9f0a00982457a27f8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: switch to the sstate mirror shared between all versionsMichael Opdenacker2022-06-271-6/+1
| | | | | | | | | Following https://git.yoctoproject.org/poky/commit/?id=cf7d8894545b83f55420fa33f7848e1bfc6754ff (From yocto-docs rev: 9f7f0e862a39f4c155dc49a816ce7cdbf799373f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: update host tool requirementsMichael Opdenacker2022-06-211-1/+2
| | | | | | | | | | | As enforced by meta/classes/sanity.bbclass: - at least GNU make 4.0 - at least GNU tar 7.5 (instead of 5.0) (From yocto-docs rev: 6480aa0f8338ef192c666b9445bc0baff47d9248) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix name capitalization issuesMichael Opdenacker2022-05-101-2/+2
| | | | | | | | | | | | - Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the title of the "BitBake User Manual". - Using "OpenEmbedded" instead of "Openembedded" - Using "Python" instead of "python" (From yocto-docs rev: 0b893e2a15aefedd7100445fc9d7eeed07b6afc6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/brief-yoctoprojectqs: add directory for local.confAbongwa Amahnui Bonalais2022-04-191-1/+1
| | | | | | | | | | Replacing local.conf by conf/local.conf (From yocto-docs rev: 0f8c773d4ef79f7a8281c5743337c0504d7a786e) Signed-off-by: Abongwa Bonalais Amahnui <abongwabonalais@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: brief-yoctoprojectqs: update video tutorialMichael Opdenacker2022-03-161-6/+6
| | | | | | | | | | Replace a 10 year-old introduction to the Yocto Project by the most recent one from Behan Webster and Tom King (Dec. 2021). (From yocto-docs rev: 92a573d690c82fb9ff717e68af5ee09da33cea2c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: propose https for SSTATE_MIRRORSMichael Opdenacker2022-02-031-2/+2
| | | | | | | | | | Both http and https work, but https should raise fewer questions from users. (From yocto-docs rev: e3bf892b1328b5c43ab041ba6c850e2782f54bdf) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* quick start manual: update Share State and Hash Equivalence settingsMichael Opdenacker2022-01-071-10/+15
| | | | | | | (From yocto-docs rev: 8668f070a5f2bf70f71f1ac53d2fac1b0faff82d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: introduce 'yocto_sstate' extlinkMichael Opdenacker2021-10-081-1/+1
| | | | | | | (From yocto-docs rev: f428c8d3bb12bfdb2b2afb03e0e6b80e28fd0e62) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace "apt-get" by "apt"Michael Opdenacker2021-10-081-1/+1
| | | | | | | | | | | | | Modern Debian based distros (such as Ubuntu) now use "apt" instead of "apt-get" Also make sure "apt" is invoked with root privileges (mandatory) (From yocto-docs rev: 380ef2474f3ecc2bce83f11cd838d054bef56d22) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify references to BitBake manualMichael Opdenacker2021-07-301-2/+3
| | | | | | | | | | | | | Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`" by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name`" when the reference description is the same as the section name. In this case, that's unnecessary to repeat the section name in the description part. (From yocto-docs rev: 6a1a590f9ef77dc8842ea5945661135992eb94e1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* quick start manual: update "source oe-init-build-env" outputMichael Opdenacker2021-07-301-1/+8
| | | | | | | (From yocto-docs rev: 0c8be05b393ea318d033af6b596da5349c75653a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-06-191-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If a variable has a glossary entry and some rST files write about those variables, it's better to point to the glossary entry instead of just highlighting it by surrounding it with two tick quotes. This was automated by the following python script: """ import re from pathlib import Path with open('objects.inv.txt', 'r') as f: objects = f.readlines() with open('bitbake-objects.inv.txt', 'r') as f: objects = objects + f.readlines() re_term = re.compile(r'variables.html#term-([A-Z_0-9]*)') terms = [] for obj in objects: match = re_term.search(obj) if match and match.group(1): terms.append(match.group(1)) for rst in Path('.').rglob('*.rst'): with open(rst, 'r') as f: content = "".joing(f.readlines()) for term in terms: content = re.sub(r'``({})``(?!.*\s*[~-]+)'.format(term), r':term:`\1`', content) with open(rst, 'w') as f: f.write(content) """ (From yocto-docs rev: ba49d9babfcb84bc5c26a68c8c3880a1d9c236d3) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify styleMichael Opdenacker2021-05-221-5/+5
| | | | | | | (From yocto-docs rev: 3332ee547cde0f2f8718f83d526b21339b0a8901) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify code insertionMichael Opdenacker2021-04-231-1/+1
| | | | | | | | | | This replaces instances of ": ::" by "::", which generates identical HTML output (From yocto-docs rev: 1f410dfc7c16c09af612de659f8574ef6cff4636) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Use variables for minimum host versions and bump Python to 3.6Paul Eggleton2021-04-151-4/+4
| | | | | | | | | | | | | Minimum Git, tar, Python and gcc versions are specified in quite a few different places. Let's add some variables for these so there's no chance of missing one if they're updated in future. Additionally, for hardknott the minimum Python version is 3.6 so set that as the value for Python. (From yocto-docs rev: 9a802bc4bb0438c2540f360a08c7787caf64408a) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Quick build: checkout a branch instead of a fixed tagMichael Opdenacker2021-04-061-24/+39
| | | | | | | | | | | - Add guidelines for choosing a release - Check-out a branch instead of a fixed tag This way it's possible to pull release updates later (From yocto-docs rev: 00b45fcf7e37616b46ca003b49c83594c061c40b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Spellcheck and capitalization fixesMichael Opdenacker2021-04-061-1/+1
| | | | | | | | | | | | | | | - Spelling fixes found using Emacs' spelling checker configured for US English - Fixes for some capitalization issues, especially some project names (QEMU, openSUSE, BusyBox), that were not consistently used with the same capitalization anyway. - A few whitespace fixes too (From yocto-docs rev: 05d69f17490dcc4933dcd85e57d9db53b912084a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Update documentation URLMichael Opdenacker2021-03-231-1/+1
| | | | | | | (From yocto-docs rev: dcedeaeb50d094d278e114928bfb63164aa7afb2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Do not assume working from $HOMEMichael Opdenacker2021-03-231-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | In the "Yocto Project Quick Build" instructions (https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#) there is an inconsistency that impacts several documents... People are first instructed to clone the poky git repository, but not mentioning from which directory. Then, it's consistent to instruct people to run "cd poky/". However, later in the instructions, readers are instructed to run "cd ~/poky", which assumes that cloning poky was done from the home directory. Many other places in the documentation make such an assumption. This change fixes this, and makes no assumption on where people have chosen to store their data, in particular where they cloned the "poky" repository. This also fixes a few whitespace issues. (From yocto-docs rev: fd4e365c85df212d7ed70fc1abb3657a4a88b294) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Use https links where possiblePaul Barker2020-12-241-1/+1
| | | | | | | (From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove 'ref' from filenamesNicolas Dechesne2020-12-091-4/+4
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: bb7e4783f45a5f67e6e4b39968f3512f43738833) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: remove 'overview-manual' from filenamesNicolas Dechesne2020-12-091-1/+1
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 4f489a40bb00be018e419802a76fec9dbee3f255) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: remove 'dev-manual' from filenamesNicolas Dechesne2020-12-091-7/+7
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 00a9244587e2e63f2a5197ed0dfc89cb330f9275) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: use absolute paths for :doc: referencesNicolas Dechesne2020-12-091-2/+2
| | | | | | | | | | | | | | | :doc: references can be made with absolute path instead of relative path. This patch was generated with this command: sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst And a few manual fixup we made for references such as: :doc:"FOOBAR <../xxx>" Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: rename top level document in each manualNicolas Dechesne2020-12-091-0/+430
It is more common to call the top level document index.rst. This is what this patch is doing, along with all required references fixup. (From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-07-24 10:51:38 +0000