You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Raspberry Pi provide SVD files with descriptions like:
<description>DW_apb_i2c address block
List of configuration constants for the Synopsys I2C hardware (you may see references to these in I2C register header; these are *fixed* values, set at hardware design time):
IC_ULTRA_FAST_MODE ................ 0x0
IC_UFM_TBUF_CNT_DEFAULT ........... 0x8
(etc)
</description>
It comes out in the Rust code as:
#[doc = "DW_apb_i2c address block List of configuration constants for the Synopsys I2C hardware (you may see references to these in I2C register header; these are *fixed* values, set at hardware design time): IC_ULTRA_FAST_MODE ....."]
I suspect this is because whitespace in XML is collapsed - any run of whitespace is converted into a single space character.
I tried putting the description in a <![CDATA[ ]> block, but a) svdtools removed it and b) even if I force it back it, svd2rust ignores it.
How can I try and make sure the whitespace in the description is carried through into the docs? In particular, I want to avoid very very very long single line descriptions appearing in https://docs.rs/rp235x-pac/latest/rp235x_pac/index.html
The text was updated successfully, but these errors were encountered:
thejpster
changed the title
Whitespace in SVD files it lost
Whitespace in SVD files is lost
Aug 18, 2024
Raspberry Pi provide SVD files with descriptions like:
It comes out in the Rust code as:
#[doc = "DW_apb_i2c address block List of configuration constants for the Synopsys I2C hardware (you may see references to these in I2C register header; these are *fixed* values, set at hardware design time): IC_ULTRA_FAST_MODE ....."]
I suspect this is because whitespace in XML is collapsed - any run of whitespace is converted into a single space character.
I tried putting the description in a
<![CDATA[ ]>
block, but a) svdtools removed it and b) even if I force it back it, svd2rust ignores it.How can I try and make sure the whitespace in the description is carried through into the docs? In particular, I want to avoid very very very long single line descriptions appearing in https://docs.rs/rp235x-pac/latest/rp235x_pac/index.html
The text was updated successfully, but these errors were encountered: