summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide/submit-changes.rst
Commit message (Collapse)AuthorAgeFilesLines
* tree-wide: make the :doc: directive use absolute pathsQuentin Schulz2025-06-201-2/+2
| | | | | | | | | | | | | | | | | | | This makes all :doc: directives use an absolute paths (with the root directory being documentation/ in the repo). This is then consistent across the whole source and is easier to review and move files around, you just need to know where a file is located relative to documentation/ directory and use that. This gets rid of paths looking in parent directory with '..' as well as expecting a file to be in the same directory as the other file it points to via the :doc: directive. (From yocto-docs rev: b9457f2005b0bea49c54e9727eb30e9458084886) Signed-off-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>
* contributor-guide/submit-changes: encourage patch version changelogsTrevor Woerner2025-05-191-0/+32
| | | | | | | | | | | | Add a section after the 'git format-patch' information encouraging developers to add patch version changelogs to their patch updates. (From yocto-docs rev: 2e3a37c4607b296956993e557d1786c4876e5722) Signed-off-by: Trevor Woerner <twoerner@gmail.com> 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>
* contributor-guide/submit-changes: add policy on AI generated codeAntonin Godard2025-02-181-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: a72dd13e6841b621c9e8f904dfaa440c186d2959) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: d3465691231f10466703198a831a681803ffdfad) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: Remove duplicated wordsTalel BELHAJSALEM2024-11-121-1/+1
| | | | | | | | | | | Remove "and then" as it is duplicated. (From yocto-docs rev: 90666b8c85fe6afaf102034ebcd5d25d8391e697) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: 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: 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: 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-301-0/+505
- 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-07-19 20:47:43 +0000