How to link between registers in HTML doc description

[vgaliCelero]

Hi,

In the generated HTML documentation using PeakRDL, I would like to create links in the desc field of one register or field that point to another register or field elsewhere in the same regmap.

reg {
    name = "snapshot";
    desc = "Value in this register is updated using the enable field in register ???.";
} snapshot_reg;

reg {
    name = "enable";
    desc = "This enables the snapshot register update.";
} enable_reg;

I want the desc of snapshot_reg to include a clickable reference to enable_reg, like:

"Value in this register is updated using the enable field in register [enable_reg]

Is there a supported syntax or macro to reference other nodes by name, path, or tag in the description that the HTML generator resolves into hyperlinks?

If not natively supported, do you recommend a workaround or hook where we can postprocess the description to inject proper links?

Thanks in advance!

[amykyta3]

Currently it is not directly supported (aside from manually implementing cross-references using Markdown links).
I do indeed plan to add support for this in the future. See this issue which details the planned feature: SystemRDL/PeakRDL-html#51

[vgaliCelero]

Sure, I'll go with manual change for time being. Thank you @amykyta3!.