add initial markdown output for memory maps#1105
Conversation
|
This looks very nice! I've got a few questions/comments:
|
Yeah I wasn't sure what to go with, maybe we should just make the call to say it's always Haskell since that's the source of truth?
Right now I just go through every memory map and just generate it as it is, I don't do de-duplication like I do for the other code generators because I thought for documentation you don't care about deduplication? I could run the deduplication pass anyway display non-shared devices differently in a - [`Uart`](..)
- [`Timer`](..)
Devices with conflicting definitions across hardware instances
- `GatherUnit`
- [`SwitchDemoPe`](..)
- [`ScatterGatherTest`](..)Opinions?
That's definitely possible! I could add that in this PR too, I don't think there's too much hurry for this? There's no plan how to make it work with mdbook yet anyway, so I can work on this :) |
We can start with that, yes. I figured you want to make
Makes sense to me! I'm sure we'll form opinions when we actually start using it.
@lmbollen has ideas |
This adds a "host binaries" cargo workspace that contains a binary that generated markdown documentation from memory maps.
This should probably be made more configurable, but I want to know what the requirements are in the first place.
So, any ideas or input @lmbollen @martijnbastiaan ?