peakrdl-html output

[vgaliCelero]

The documentation generator produces individual HTML files (per register/register block). When a new register is added in the middle of the address space, it causes extensive line shifts across multiple generated HTML files, leading to noisy commits and difficult diff reviews.

Question:
Is there a way to structure the documentation output so that adding registers doesn't trigger widespread changes across numerous HTML files in the repo?

Regards,
Vasu

[amykyta3]

No there's not much that can be done about that. The generated HTML distills multiple aspects of the design in order to support dynamic loading. Not only is there the content pages themselves, but the index files that make the search function work properly. Controlling line diffs for an inverted index in the way you describe is basically impossible.

In general, I usually recommend against checking in the generated HTML into any git repository since it is not something that is particularly appropriate to add to revision control as it is generated content from original source.

[vgaliCelero]

Thanks Alex. We'll figure out a way to avoid pushing these files into GIT.