summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide
Commit message (Collapse)AuthorAgeFilesLines
* contributor-guide/submit-changes: add policy on AI generated codeAntonin Godard3 days1-0/+49
| | | | | | | | | | | | | | Based on message by Richard Purdie on the yocto-docs list: https://lists.yoctoproject.org/g/docs/message/6300 Re-formatted for the Yocto Project documentation syntax. (From yocto-docs rev: da3aa5ba9387ca5bb7ddd75fe6f7962d0629ea90) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a72dd13e6841b621c9e8f904dfaa440c186d2959) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide/submit-changes.rst: suggest to remove the git signatureAntonin Godard2025-01-091-0/+7
| | | | | | | | | | | | | | By default when sending patches Git adds the git version at the bottom of the patch, which is not necessary in most cases. Suggest to remove it when configuring Git when sending patches. Suggested-By: Jaekyu Lee <jaekyu.lee@lge.com> (From yocto-docs rev: 05455e916b3c94a73b358ac4f4189cc66bec35f2) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d3465691231f10466703198a831a681803ffdfad) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Update the documentation for SRCPVAntonin Godard2024-12-231-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | The variable SRCPV is deprecated since 4.3. Instead of including SRCPV in PV, including the sign "+" is enough for bitbake to add the source control information to PKGV during the packaging phase. Update the documentation for SRCPV and the places where it was used. When instructions previously referred to SRCPV, replace by mentioning to include "+" in the assignment. In most examples, "+git" is added to PV as it is the most popular SCM. Simply adding "+" is also possible, although it is better practice to include the SCM name, so give that example. Update the gcompat example with l3afpad as it didn't include "+git" in its PV definition anymore. (From yocto-docs rev: ef4d259842d9b1dd2d08ee38e00f932852f70543) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit ee16c96202e5027d1a8d7e89e11c25f127c78326) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: Remove duplicated wordsTalel BELHAJSALEM2024-11-181-1/+1
| | | | | | | | | | | | | Remove "and then" as it is duplicated. (From yocto-docs rev: 4eb28bf7e1ee52ee5abb5302169685d849cf1b91) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 52ed947120e400620277a58f895294b558a9324e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* conf.py: rename :cve: role to :cve_nist:Antonin Godard2024-11-091-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Newer versions of Sphinx already define a :cve: role that points to cve.org, instead of the role we defined in conf.py that points to nvd.nist.gov. Rename our role to :cve_nist: to avoid warnings (treated as errors). This is also backwards compatible, meaning we can build the doc with an older Sphinx if needed. The file were automatically replaced with following command: find . -name '*.rst' -exec sed -i 's/:cve:/:cve_nist:/g' {} \+ Cherry pick: * remove changes to release-notes-5.1.rst, does not exist on this branch. * release-notes-5.0.4.rst: apply the command to this file as it was treated previously. Suggested-By: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 5b86879b3b5f3c51bc7fa5dd2848cf1153a22242) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 15fa3b7e85dde50d7236c1738ad607531cc654b8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: refer to new yocto-patches mailing list wherever appropriateQuentin Schulz2024-04-081-1/+1
| | | | | | | | | | | | | | There's a new yocto-patches mailing list available for all layers that do not have their own mailing list. c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684 Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: ac512f76b93a20507a6835ddafa954b4ae45e268) 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>
* contributor-guide: be more specific about meta-* treesMartin Jansa2024-03-191-1/+1
| | | | | | | | | | | | * this is often confused to apply for e.g. meta-oe as well where it doesn't apply as meta-oe has own ML mentioned in README. (From yocto-docs rev: 63be0814a7ecf38c570b6d776f62b7c7803eb299) Signed-off-by: Martin Jansa <martin.jansa@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: add notes for testsSimone Weiß2024-03-061-2/+35
| | | | | | | | | | | | This adds some hints that and how changes should be tested when contributing. Fixes [YOCTO #15412] (From yocto-docs rev: 6f3dbb2a909ba5b71efb09b251ee3f8650e30146) 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>
* contributor-guide: fix lore URLbaruch@tkos.co.il2024-02-051-1/+1
| | | | | | | | | Cc: Michael Opdenacker <michael.opdenacker@bootlin.com> (From yocto-docs rev: 5962a09a120681c1328e05335c2f14fad06c63ce) Signed-off-by: Baruch Siach <baruch@tkos.co.il> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: use "apt" instead of "aptitude"Michael Opdenacker2024-01-121-1/+1
| | | | | | | | | As used in the rest of the manual. (From yocto-docs rev: 5a5dfc446bb62568da50056660d18c5c309d1051) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: fix command optionMichael Opdenacker2023-12-011-1/+1
| | | | | | | | | "--subject-prefix" applies to "git format-patch", not "git send-email" (From yocto-docs rev: d0e255f4ace445e076f37d42bbc69378f5985c59) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: add License-Update tagJustin Bronder2023-12-011-0/+12
| | | | | | | | | | | Porting from the old wiki https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935#Describing_license_changes (From yocto-docs rev: 51e55b44a4532ae16595bd5a712c34deeff5d47b) Signed-off-by: Justin Bronder <jsbronder@cold-front.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: clarify patchtest usageTrevor Gamblin2023-10-201-5/+11
| | | | | | | | | | | | | | - Make it clear that patchtest only supports openembedded-core for now - Add a short list of instructions for installing Python module dependencies on the host - Add a step to add meta-selftest with bitbake layers so that all tests can run (From yocto-docs rev: bcd58d68e72226be1930593f5f7fb37de15b7913) Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: add patchtest sectionTrevor Gamblin2023-10-201-0/+34
| | | | | | | | (From yocto-docs rev: 236cd04d62bdf653aae9b41d32d9f87848a34339) Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: style-guide: discourage using Pending patch statusRoland Hieber2023-09-251-1/+8
| | | | | | | | | | Suggested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: 4924c900582aaa803b003e10e48fc4a4373f6a77) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: deprecate "Accepted" patch statusRoland Hieber2023-09-251-8/+5
| | | | | | | | | | | | | | | | | | | | This is in accordance with the gatesgarth Release Notes: > In the ``Upstream-Status`` header convention for patches, > ``Accepted`` has | been replaced with ``Backport`` as these almost > always mean the same thing i.e. the patch is already upstream and > may need to be removed in a future recipe upgrade. If you are adding > these headers to your own patches then use Backport to indicate that > the patch has been sent upstream. <https://docs.yoctoproject.org/migration-guides/migration-3.2.html#miscellaneous-changes> Suggested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> (From yocto-docs rev: 61813da94595a6e57c5fb5015229d601a558f299) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: discourage marking patches as InappropriateRoland Hieber2023-09-251-16/+14
| | | | | | | | | | | | | | It was never really clear what all those reasons really meant, and every patch submitted upstream liftens the maintenance on the Yocto side. So remove the current list, and replace it with two reasons in which an upstream submission likely won't benefit the upstream project. Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: 7e630fdb98e1a28abb09c8f24c90ada0a4a1b9f3) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: recipe-style-guide: add section about CVE patchesRoland Hieber2023-09-251-0/+25
| | | | | | | | | | | | | | | | | | | This was previously included in the OpenEmbedded wiki page [1], but was not ported along with the rest in commit 95c9a1e1e78bbfb82ade (2023-09-12, Michael Opdenacker: "contributor-guide: recipe-style-guide: add Upstream-Status"). [1]: https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935 Group the examples in their own sections (but name it differently from any other section in this document so that sphinx doesn't generate a warning about duplicate labels). (From yocto-docs rev: 3022caa35efc28d16dea81bc81ecb48998c8f3b8) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: recipe-style-guide: add more patch tagging examplesRoland Hieber2023-09-251-1/+20
| | | | | | | | (From yocto-docs rev: a2904fd3ccdcb1d7232adce51966749cb1e3cb92) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide/style-guide: Add a note about task idempotenceRichard Purdie2023-09-251-0/+14
| | | | | | | | (From yocto-docs rev: 7d715d62c32ab81d26bf1ff82f79ad2c4a2e3f85) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> CC: Yoann Congal <yoann.congal@smile.fr> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide/style-guide: Refer to recipes, not packagesRichard Purdie2023-09-251-7/+8
| | | | | | | | | | | Whilst often referred to as packages by people we should use the more accurate term in documentation, 'recipe' instead of 'packages'. (From yocto-docs rev: 058de5ad48ab76c4d54391f1701c3082842e8794) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: recipe-style-guide: add Upstream-StatusMichael Opdenacker2023-09-191-0/+81
| | | | | | | (From yocto-docs rev: 95c9a1e1e78bbfb82adef588f68d5d891fb64358) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: submit-changes: how to request push access to repositoriesMichael Opdenacker2023-08-301-3/+12
| | | | | | | | | | Including content currently on http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded (From yocto-docs rev: 34b22fd3c48d55bcddbf725395f9ee4e389ae354) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: submit-changes: commit guidelines for recipesMichael Opdenacker2023-08-301-0/+5
| | | | | | | | | | Adding text currently on http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded (From yocto-docs rev: 716756045b75e64846421dcecdd044a06b88052a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: submit-changes: improvements to mailing lists sectionMichael Opdenacker2023-08-301-13/+16
| | | | | | | | | | | | | - Add missing reference to openembedded-devel list - Improve the text to clarify explanations, remove redundant information and include information currently on http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded (From yocto-docs rev: a359be596138d0454c7596ccbfd48f7ad307980a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: submit-changes: reorganize and develop sectionsMichael Opdenacker2023-08-301-140/+262
| | | | | | | | | | | In particular, develop the sections about sending patches. Reorder sections for a more logical flow. Remove unnecessary or duplicate details too. (From yocto-docs rev: 6c37d5bd9be7e65c923c3e95f478afc0e6064e8f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: README: update list of manualsMichael Opdenacker2023-08-301-10/+38
| | | | | | | (From yocto-docs rev: 30166df4a85a2bbd1da98440e701de72e56fa9f3) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: submit-changes: develop sending patches sectionMichael Opdenacker2023-08-301-9/+20
| | | | | | | (From yocto-docs rev: 0cfb8417236a8a82eebe7901bc24164227cfe4b2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: submit-changes: detail commit and patch creationMichael Opdenacker2023-08-301-38/+110
| | | | | | | | | | | | | | Add missing steps and try to provide better guidance and more modern solutions, for example keeping track of the cover letter in the branch itself. Also add subsections to divide the instructions into easier to understand parts. (From yocto-docs rev: 4abe87cb20d3f023d5b0178450823d072d3321c8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: identify component: provide link to repositoriesMichael Opdenacker2023-08-301-4/+6
| | | | | | | (From yocto-docs rev: 634d1a946ec872b3e8e20bb9a726649a8d7a0d60) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: submit-changes: simplify noteMichael Opdenacker2023-08-301-3/+2
| | | | | | | (From yocto-docs rev: fb507fb37fe0c078144932ff39ba0ef952614361) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor guide: update instructions for making and sharing changesMichael Opdenacker2023-08-302-65/+69
| | | | | | | | | | | | - Shifting the focus to multiple changes instead of just one - Advising to create a branch for changes - Removing unnecessary or too verbose explanations - Adding useful resources and examples (From yocto-docs rev: e7e47121fd979e034f8f40a043912640a6a25a5e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: clarification about patchtestMichael Opdenacker2023-08-301-2/+2
| | | | | | | | | | - Highlight that patchtest still needs improving - Fix reference to this tool (From yocto-docs rev: bdd5541b491729dcfa9e92a9acfc932c427a8ea0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor guide: remove unnecessary information about mailing listsMichael Opdenacker2023-08-301-7/+4
| | | | | | | | | The mailing lists for sending code are sufficient! (From yocto-docs rev: 2ea840c34043d4d630ad2deae0ffd285503d1078) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: remove obsolete pkg-config guidelinesMichael Opdenacker2023-08-301-5/+0
| | | | | | | | | | | | They were coming from obsolete notes from the times when people directly created or modified .pc files from their recipes. Nobody should be doing that any more and keep this can be confusing. (From yocto-docs rev: 6b3bbf9507ac7014e95926d69383b585c5e19371) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor guide: call section "Reporting a defect"Michael Opdenacker2023-08-302-2/+2
| | | | | | | | | | | | | Instead of "Submitting a defect". We all write bugs, and nobody needs documentation support for doing so! (From yocto-docs rev: ce94f6ed029afc8c69e84354c03bd0a9ab14f867) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove AUTHOR variableMichael Opdenacker2023-08-301-1/+0
| | | | | | | | | Following https://git.openembedded.org/openembedded-core/commit/?id=9d5edd124b7dddb995ceddd79f8a7fc8cf44badf (From yocto-docs rev: e7da4d122313f369be1c680dadd76ea53ba8dd04) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: add recipe style guideMichael Opdenacker2023-08-302-0/+264
| | | | | | | (From yocto-docs rev: a61a7677adb9bf22dc0d28e72a8fedf2df27e80a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: add section about why we use mailing listsMichael Opdenacker2023-08-301-5/+45
| | | | | | | (From yocto-docs rev: dda13405221102b66b0e08bee3004d0ce1c0c000) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: add missing links to mailing listsMichael Opdenacker2023-08-301-2/+3
| | | | | | | | | And fix such a link too. (From yocto-docs rev: 7528d6afec675080a9140f1a1f0064b4a76f39b0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: create a dedicated "Contributor Guide" documentMichael Opdenacker2023-08-304-0/+584
Starting from the original contents of dev-manual/changes.rst and from text contributed by Richard Purdie. (From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-02-24 14:34:28 +0000