WIP: updated code-layout diagram #106475

Campbell Barton · 2023-04-03T03:45:34+02:00

Campbell Barton commented

2023-04-03 03:45:34 +02:00

Add a utility to generate a diagram showing an overview of Blender's code-base, updating the old code-layout diagram from: https://www.blender.org/bf/codelayout.jpg

See:

Rationale

The original diagram was a quick way to get an overview of a large code-base, wile not entire accurate (bad level calls for e.g.), it's helpful to show a top-level view of the code-base.

TODO

Support validating the diagram against Blender's code-base for completeness.
Some descriptions should be improved (this is a first pass).
Add command line argument parsing (to set the output file).
Minor code-cleanup.

Open Topics

We might want to list ../lib/ elsewhere as it's now quite large and not something users will encounter when navigating the code-base.

Further Work

We might consider having a README in each of these directories which is used as a data-source. It's convenient to update, useful for anyone navigating the code-base and means this information doesn't have to be copied between this diagram & https://wiki.blender.org/wiki/Source/File_Structure
Although we would most likely have to use a convention to support extracting a summary for the purpose of the diagram.

Add a utility to generate a diagram showing an overview of Blender's code-base, updating the old code-layout diagram from: https://www.blender.org/bf/codelayout.jpg ---- See: ![updated image](https://download.blender.org/ftp/ideasman42/pics/code_layout.webp) #### Rationale The original diagram was a quick way to get an overview of a large code-base, wile not entire accurate (bad level calls for e.g.), it's helpful to show a top-level view of the code-base. #### TODO - Support validating the diagram against Blender's code-base for completeness. - Some descriptions should be improved (this is a first pass). - Add command line argument parsing (to set the output file). - Minor code-cleanup. #### Open Topics - We might want to list `../lib/` elsewhere as it's now quite large and not something users will encounter when navigating the code-base. #### Further Work We might consider having a README in each of these directories which is used as a data-source. It's convenient to update, useful for anyone navigating the code-base and means this information doesn't have to be copied between this diagram & https://wiki.blender.org/wiki/Source/File_Structure Although we would most likely have to use a convention to support extracting a summary for the purpose of the diagram.

🎉 1

Campbell Barton force-pushed pr-code-layout-diagram from ad0a888f96 to 6c861e8f5f

2023-04-03 04:07:29 +02:00

Compare

Ray molenkamp commented

2023-04-03 04:39:45 +02:00

I did some work mapping out the deps between libs for D12122

It's probably better to make this new updated graph logical or how we want it to be rather than trying to base it on reality, which is.... yeah.....

https://archive.blender.org/developer/file/10266/10266294/full.png

red lines are circular dependencies, dependencies are modeled upon the import/exports out of the static libs.

I did some work mapping out the deps between libs for [D12122](https://archive.blender.org/developer/D12122) It's probably better to make this new updated graph logical or how we want it to be rather than trying to base it on reality, which is.... yeah..... https://archive.blender.org/developer/file/10266/10266294/full.png red lines are circular dependencies, dependencies are modeled upon the import/exports out of the static libs.

Campbell Barton force-pushed pr-code-layout-diagram from 6c861e8f5f to 4653173ed7

2023-04-03 12:51:47 +02:00

Compare

Campbell Barton force-pushed pr-code-layout-diagram from 4653173ed7 to b5969df65e

2023-04-05 05:53:56 +02:00

Compare

This pull request is marked as a work in progress.

View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u pr-code-layout-diagram:ideasman42-pr-code-layout-diagram

git checkout ideasman42-pr-code-layout-diagram

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

WIP: updated code-layout diagram #106475

Rationale

TODO

Open Topics

Further Work

Checkout