summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide
Commit message (Collapse)AuthorAgeFilesLines
* 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 2024-11-16 11:34:01 +0000