summaryrefslogtreecommitdiffstats
path: root/documentation/README
Commit message (Collapse)AuthorAgeFilesLines
* manuals: README: update list of manualsMichael Opdenacker2023-08-301-3/+5
| | | | | | | (From yocto-docs rev: 30166df4a85a2bbd1da98440e701de72e56fa9f3) 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-5/+13
| | | | | | | | | | | | | | | | | | | | - 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>
* Documentation/README: formalize guidelines for external link syntaxMichael Opdenacker2022-10-281-0/+13
| | | | | | | (From yocto-docs rev: f5d10ceed943270d7bcfa31b5936f37a60669c7f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: README: add TeX font package required for building PDFQuentin Schulz2022-08-121-0/+4
| | | | | | | | | | | | | The fncychap.sty font needs to be installed on the host in order to be able to build the PDF version of the docs, so let's mention it in the README. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 97fb41801fb7ac1439f8af03d2da2fb2f171a7e6) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: correct heading styles actually used in the YP manualsMichael Opdenacker2022-03-161-11/+12
| | | | | | | | | | | | | | Sphinx seems to offer flexibility in heading styles definitions, but the new text matches the way subsubsections and subsubsubsections are defined in the current manuals. Note that it's not possible to mix different definitions, for example by using "~~~~" and "^^^^" for subsubsections in different places. (From yocto-docs rev: 89a9af58adaa4cf4708d0383655b992f8c7239e2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: how to upgrade Sphinx packagesMichael Opdenacker2022-03-041-2/+7
| | | | | | | (From yocto-docs rev: 199c6ef4b64d6c7f672ac183d3bf73c8ff3bb2c7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: trivial typo fixMichael Opdenacker2022-01-071-1/+1
| | | | | | | (From yocto-docs rev: f3f252c08a8ae9b492d766fd8a7168baf7467a07) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: start of documentation standards documentMichael Opdenacker2021-11-071-3/+10
| | | | | | | | | This first version specifies how to create consistent SGV graphics (From yocto-docs rev: 370b9e34e9092c9eed22df2e8b2d0bb979487e5c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: allow epub and latexpdf outputs to use diagrams from SVG sourcesMichael Opdenacker2021-10-081-0/+4
| | | | | | | | | | | | | | | | | | | | | | html output is great when directly using SVG epub output has to use exported PNG because of issues using SVG directly latexpdf output cannot use SVG, it needs exported PDF instead This adds rules to generate PNG and PDF formats from new SVG sources. Newly added diagrams have be stored in svg/ subdirectories so that PNG and PDF files generated from SVG can be "gitignored" without ignoring the original PNG diagrams that have no SVG source. Note: had to remove the dependency to "Makefile" in the final "catch-all" target, otherwise it was also catching the SVG to PNG and SVG to PDF targets. (From yocto-docs rev: cd9bbd41d323bc124057396f142010509c65bbaf) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: update manual list and names, online docs URLRobert P. J. Day2021-09-041-16/+11
| | | | | | | | | | | | | Minor tweaks to top-level README: - add missing line for overview manual - correct manual names to match their *actual* names - point reader at docs.yoctoproject.org for online docs (From yocto-docs rev: 0ce9097728dbdca926fdf7065490207d09a34cb0) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: improve BitBake manual referencing guidelinesMichael Opdenacker2021-07-301-3/+12
| | | | | | | | | | | | Removing the ":ref:`-D <bitbake:..." syntax as it's not necessary Adding more and simpler ways of making references to the BitBake manual. (From yocto-docs rev: 7ad087a81e5dca7088c8088cd0cdcf31606baa6e) 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>
* README: Tweak as the website isn't really new nowRichard Purdie2021-06-161-2/+2
| | | | | | (From yocto-docs rev: 78c50ffffb6f4dd38b5097a64c2e284a6177750a) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify styleMichael Opdenacker2021-05-221-1/+1
| | | | | | | (From yocto-docs rev: 3332ee547cde0f2f8718f83d526b21339b0a8901) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: reduce verbosity related to "the following" expressionMichael Opdenacker2021-05-131-1/+1
| | | | | | | (From yocto-docs rev: da9d1cfb5c084d172eff3cb10ec3631dd8266260) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: replace anchor linksQuentin Schulz2021-04-091-0/+3
| | | | | | | | | | | | | | | | | | Anchor links are treated by Sphinx as external links and are not checked during build, meaning it is impossible to know if a link becomes broken or not. As a matter of fact, most of the anchor links replaced in this commit were actually broken. The README now states that anchor links are forbidden so that there's no need to go through such a change later on. (From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Fix typos and spacingMichael Opdenacker2021-04-061-1/+1
| | | | | | | | | | Fix double words, punctuation spacing issues, spacing issues, "its" instead of "it's", and other trivial issues. (From yocto-docs rev: 56eb1f340a7af112e62c1d8ad02d4bec0ad88313) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README minor improvementsMichael Opdenacker2021-03-231-11/+16
| | | | | | | | | | | | | | | | - Minor style and spelling fixes - Add some extra details; add missing external link macros and explain where they are defined - Correct where documentation can be found on the Yocto Project website: the "Documentation" tab has been replaced by "Docs" (and it's later shown as uppercase ("DOCS") by the current CSS, but this may change one day. (From yocto-docs rev: ed7b4f318c9ba6cf501f1e551c7a8eb4aaee1396) 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-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | 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-4/+4
| | | | | | | (From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: Refer to top-level README for contributionsPaul Barker2020-11-201-0/+6
| | | | | | | | | | This may help anyone looking for patch contribution guidelines in the documentation directory itself. (From yocto-docs rev: 276740dd3780b0bdf04996efeed3c237fd26da1f) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Add Pipenv supportJoshua Watt2020-11-121-0/+7
| | | | | | | | | | Adds a Pipfile so that Pipenv can be used to automatically install all the dependencies required to build the documentation (From yocto-docs rev: 31658ad30827d38dcd4ea83bcfb828441c7c3eca) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: "yocto-project-qs" -> "brief-yoctoprojectqs"Robert P. J. Day2020-10-301-9/+9
| | | | | | | | | | Directory has been renamed, so fix README and add a bit more white space to keep everything lined up. (From yocto-docs rev: cdd4c705f7271e31e44a94c79b050eda1fba5945) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: rename Makefile.sphinxNicolas Dechesne2020-10-061-1/+1
| | | | | | | | | | Now that the DocBook files are removed, we can rename the top level Makefile. (From yocto-docs rev: 25fefa9a91ba5d7b398443f543e2c46165e8a3f4) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: include detailed information about sphinxNicolas Dechesne2020-09-291-28/+255
| | | | | | | | | | | * Updated the README to include instructions to build the doc with sphinx * Added design guidelines for new contributors (From yocto-docs rev: 7f64574f7594de22fbd29d9da9b8c9df4ba05ffb) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to change dev-manual titleScott Rifenbark2017-10-301-2/+2
| | | | | | | | | | | | Updated several files to change the title of the dev-manual from the "Yocto Project Development Manual" to the "Yocto Project Development Tasks Manual." Did some edits in the README and the Makefile as well for completeness. (From yocto-docs rev: 0278d6d3bb458af1cb04fbc3eed96dff12d19475) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: Updated to remove the ADT manual and add the SDK manual.Scott Rifenbark2016-04-061-4/+6
| | | | | | | (From yocto-docs rev: 61474479f84e2f611684db152e7682275f8f19c3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: Updated the file to reflect current state of documentationScott Rifenbark2013-08-131-34/+31
| | | | | | | | | | | This file was out of date. I replaced the kernel-manual descriptions with dev-kernel. Also, added the profiling manual. Finally, changed the poky-ref-manual string to ref-manual. (From yocto-docs rev: a1e60078dcfcfd5a912d78f981fe70dc1aa33e37) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: updated to include website information.Scott Rifenbark2012-09-241-0/+9
| | | | | | | (From yocto-docs rev: 439bd3c11e46d653234da928cfea6ab46666f0f2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: Updates for mega-manualScott Rifenbark2012-09-041-2/+10
| | | | | | | | | Added information about the mega-manual. (From yocto-docs rev: bbf75682f957ad2e124aa9476f52cd2bd3829fa6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: Updates to explain developmentScott Rifenbark2012-03-231-2/+27
| | | | | | | | | | | | | I added information that describes the relationship between poky/documentation and yocto-docs/documentation. For developers, they need to know to work from the yocto-docs Git repository and not to rely on the poky/documentation Git repository, which can lag behind the other one. (From yocto-docs rev: 0cbc781d3e9544c9920fdaf4548d882dd79b3d6c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: Created a README fileScott Rifenbark2012-03-081-0/+52
Initial file. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 37fea0686161333338ca79710e0bf75a67b14c5f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-16 21:53:03 +0000