Hi Enrico, On Wed Dec 18, 2024 at 2:32 PM CET, Enrico Jörns wrote: > Hi Antonin, > > Am Mittwoch, dem 11.12.2024 um 15:19 +0100 schrieb Antonin Godard: >> Hello Enrico, >> >> Since this patch series introduces a new class for compiling barebox-based >> bootloaders, it would be nice to have some documentation for it. >> >> Openembedded-core classes are documented in yocto-docs[1], and documentation >> patches are sent to [email protected]. >> >> Could anyone, preferably the author of the class, take some time to document >> the >> usage of the class in yocto-docs/documentation/ref-manual/classes.rst, and >> the >> variables the class defines (especially the ones that can be overridden for >> user >> customization) in yocto-docs/documentation/ref-manual/variables.rst? > > thank you for reaching out regarding the documentation of the barebox.bbclass. > > I was on vacation last week and still have some year-end tasks to take care of > this week, so I'm not sure how soon I'll get to it.
Ideally, some time before the next Walnascar release would be great. I've created a bug to track this: https://bugzilla.yoctoproject.org/show_bug.cgi?id=15702. > However, I’m happy to contribute the corresponding class documentation. > >> That would be greatly appreciated. I can help if needed. > > Thanks a lot! I'll get back to you in case something is unclear (e.g. where > to put which > information). Luckily all the documentation is rst which I am quite familiar > with 🙂. > > For now I've checked out the repo and added a barebox section header in > classes.rst -- > just to give myself the impression of having started already 😉. Great! I'm looking forward to your patches. :) One advice I would give is to read documentation/standards.md. There are some yocto-docs specific terms and formatting rules to follow. Thanks, Antonin -- Antonin Godard, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
-=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#208980): https://lists.openembedded.org/g/openembedded-core/message/208980 Mute This Topic: https://lists.openembedded.org/mt/108947159/21656 Group Owner: [email protected] Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [[email protected]] -=-=-=-=-=-=-=-=-=-=-=-
