aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2020-12-21ref-manual: use consistent capitalisation of U-Bootpaule/fitimage-docsPaul Eggleton
Change all instances of U-boot to U-Boot. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2020-12-21variables: Add documentation for new kernel-fitimage varsPaul Eggleton
Add documentation for FIT_DESC, FIT_SIGN_INDIVIDUAL, UBOOT_MKIMAGE, UBOOT_MKIMAGE_SIGN and UBOOT_MKIMAGE_SIGN_ARGS. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2020-12-21variables: explicitly state that UBOOT_MKIMAGE_DTCOPTS is optionalPaul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2020-12-21variables: clarify KERNEL_ALT_IMAGETYPE referencePaul Eggleton
Make it clear that KERNEL_ALT_IMAGETYPE is intended to allow building an additional image type. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2020-12-21classes: minor corrections to kernel-fitimage sectionPaul Eggleton
Minor syntax and formatting corrections. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2020-12-15releases: conf: add link to 3.2.1, update to include 3.2.1Michael Halstead
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
2020-12-03ref-manual: remove 'ref' from filenamesNicolas Dechesne
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 Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03sdk-manual: remove 'sdk' from filenamesNicolas Dechesne
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 Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03overview-manual: remove 'overview-manual' from filenamesNicolas Dechesne
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 Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03profile-manual: remove 'profile-manual' from filenamesNicolas Dechesne
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 Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03kernel-dev: remove 'kernel-dev' from filenamesNicolas Dechesne
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 Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03dev-manual: remove 'dev-manual' from filenamesNicolas Dechesne
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 Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03toaster-manual: remove 'toaster-manual' from filenamesNicolas Dechesne
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 Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03test-manual: remove 'test-manual' from filenamesNicolas Dechesne
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 Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03sphinx: use absolute paths for :doc: referencesNicolas Dechesne
: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> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03sphinx: rename top level document in each manualNicolas Dechesne
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. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03ref-manual: Simplify oe_git linksPaul Barker
Manual links to git.openembedded.org are converted to use the oe_git directive where possible. Note that this directive can't be used in some places such as example code. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-03documentation: Simplify yocto_git linksPaul Barker
The yocto_git external link directive is modified to include the `/cgit/cgit.cgi` element of the URL so that we can simplify the links in the text. Manual links to git.yoctoproject.org are converted to use the yocto_git directive where possible. Note that this directive can't be used in some places such as example code. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-03documentation: Simplify yocto_wiki linksPaul Barker
The `yocto_wiki` external link directive is modified to include the `/wiki` element of the URL so that we can simplify the links in the text. Note that there are still a couple of places where this directive cannot be used, such as in the table of contents in index.rst. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-03dev-manual: remove unused labelsNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-03overview-manual: remove unused labelsNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-03sdk-manual: replace labels with references to section titleNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-03ref-manual: replace labels with references to section titleNicolas Dechesne
2020-12-03dev-manual: replace labels with references to section titleNicolas Dechesne
2020-12-03brief-yoctoprojectqs: replace labels with references to section titleNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-03sphinx: replace bitbake labels with references to corresponding titleNicolas Dechesne
In order to remove autogenerated labels in the bibtake docs, let's use section titles in all YP docs. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-03releases.rst: add gatesgarth to current releasesAnuj Mittal
Signed-off-by: Anuj Mittal <anuj.mittal@intel.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-03{dev,kernel,sdk}-manual: replace hardcoded release version with &DISTRO;Nicolas Dechesne
In the Docbook files we had DISTRO, but somehow it was lost during the migration to Sphinx. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-03sphinx: add .vscode in .gitignoreNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-12-02releases: conf: add link to 3.1.4, update to include 3.1.4Michael Halstead
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
2020-11-23Drop old presentations from repositoryPaul Barker
The `presentations` directory contained two talks which are now over 7 years old and are unlikely to be relevant to current users of the project. They don't fit in well with the rest of the contents of this repository and should be dropped. If anyone wants them, they'll still be stored in the git history :) Signed-off-by: Paul Barker <pbarker@konsulko.com>
2020-11-23poky.yaml: Define DISTRO_NAME_NO_CAP_LTSPaul Barker
This allows us to reference the branch name for the latest LTS release (currently dunfell) in the text. When the current release is an LTS, this variable will be equal to DISTRO_NAME_NO_CAP. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-23dev-manual-common-tasks: Re-order patch submission instructionsPaul Barker
New contributors to the project will usually be following the steps to submit patches directly via email as they may not have commit access to a contrib repository. For shorter series of patches this is the more common workflow which we see anyway. The documentation here is updated to reflect this, addressing the email submission process first and then the pull request process. The new opening paragraph for the section on submitting pull requests is taken from the "How to submit a patch to OpenEmbedded" page on the OE wiki. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-23dev-manual-common-tasks: Describe how to propose changes to stable branchesPaul Barker
The documentation on submitting changes to the project should cover the ways in which the process differs for stable branches. These changes add a brief description of the typical policy for handling changes to stable branches and give some steps to follow when proposing changes to these branches. The information is based on my personal experience and on the existing content of the "How to submit a patch to OpenEmbedded" page on the OE wiki. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-23dev-manual-common-tasks: Describe how to handle patch feedbackPaul Barker
The contribution guidelines would benefit from a brief section on how to address feedback from patch reviewers and how to re-submit amended patches. The information here is based on my personal experience and on the existing notes on the "How to submit a patch to OpenEmbedded" page on the OE wiki. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-23dev-manual-common-tasks: Describe git-send-email accuratelyPaul Barker
Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-23dev-manual-common-tasks: Tidy up patch submission processPaul Barker
Reduce duplication by pulling out the common steps of committing changes locally from the steps of submitting those changes via the pull request scripts or via email. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-23dev-manual-common-tasks: Update & move patchwork referencePaul Barker
Add a link to our patchwork instance and note how submitted patches are checked for common mistakes. This note is moved to the section on submitting patches via email as that is the place where most users will run into patchwork/patchtest. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-23dev-manual-common-tasks: Fix refs to testing branchesPaul Barker
After discussions on IRC with Ross we concluded that the `ross/mut` branch shouldn't really be listed in the docs as it's more of a personal test branch. Instead we should list the -next branches for openembedded-core and poky. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20documentation/README: Refer to top-level README for contributionsPaul Barker
This may help anyone looking for patch contribution guidelines in the documentation directory itself. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20conf.py: Add oe_git directivePaul Barker
This simplifies linking to git repositories on openembedded.org. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20Makefile: enable parallel buildNicolas Dechesne
>From sphinx-build man page: -j N build in parallel with N processes where possible (special value "auto" will set N to cpu-count) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20toaster-manual: remove unused labelsNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20sdk-manual: remove unused labelsNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20profile-manual: remove unused labelsNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20kernel-dev: remove unused labelsNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20bsp-guide: remove unused labelsNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20test-manual: remove unused labelsNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20kernel-dev: replace labels with references to section titleNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20dev-manual: replace labels with references to section titleNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-04-28 02:50:44 +0000