On Wed, 2018-04-25 at 09:12 +0000, Sander Striker wrote:
Hi Tristan, On Wed, Apr 25, 2018 at 10:24 AM Tristan Van Berkom <tristan vanberkom codethink co uk> wrote: [...]On Tue, 2018-04-24 at 15:39 +0000, Sander Striker wrote:I think we can be doing something to make it easier for new members of the project to find their way in the codebase. HACKING.rst does explain rules around submissions, the coding style, etc, but it doesn't refer to an overall architecture. I think we can make it more feasible for people to understand the whole codebase by providing an architecture overview with references to the codebase. One perspective is to also follow the flow of the `bst` commandline client, and explaining what happens where. In light of the BuildStream as a library thread, other perspectives will follow further down the line. I'll try to contribute something in this space, but will solicit some help :)Yes, I'd like to have an architectural document, which of course is a tricky balance because, it adds to the list of things to be maintained. I have some initial design material which I can perhaps reuse, which includes some cute libreoffice diagrams describing the data model which can be of help... I will try to find time to make something like this happen.I'm happy to help if you want to share some of that raw material.
Alright what the hell :)
I'm attaching here the "original plan", the core codebase has certainly
diverged in many ways, but the implementation is surprisingly close to
what I had originally envisioned.
Ignore the fact that it says "v2.2", that's just my revisioning of a
document without any VCS.
I'll also attach the rendered PDF in case anyone wants to read it more
easily than using libreoffice.
Cheers,
-Tristan
Attachment:
build-stream-design-v2.2.odg
Description: application/vnd.oasis.opendocument.graphics
Attachment:
build-stream-design-v2.2.pdf
Description: Adobe PDF document