Skip to content

ipbb gendecoders format is not compliant with ipbb vhdl-beautify #234

Description

@HendrikKrause

Summary

The VHDL formatting of the IPbus decoder files produced by ipbb ipbus gendecoders is not compatible with the formatting produced by
ipbb toolbox vhdl-beautify. Because the two tools format files differently, running the beautifier over decoder files always yields changes, which pollutes git history with spurious diffs.

Actual behaviour

Starting from a beautified source area. During ipbb ipbus gendecoders, all decoder files get an updated format and a new timestamp even if the logic doesn't change. These updated timestamps remain after running vhdl-beautify again, leading to every decoder file containing changes before doing a git commit.

Workaround

The workaround is to run git restore *ipbus_decode_*.vhd to restore every decoder file. This is not ideal because if the logic changes you want to commit the changes and then an automated exclusion is not possible.

Proposed Solution

Make both formatters share the same VHDL formatting rules so the two commands produce identical output. Ideally, gendecoders would emit code that is already "beautified", or internally run the same beautification step.

Screenshot Showing the Different Formatting

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions