rust-embedded / rust-embedded/svd
[svd_parser]: Tags that contain a XML comment are ignored.
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 84
- Forks
- 64
- PR merge metrics
- No merged PRs in 30d
Description
svd_parser 0.14.1
If a tag contains a XML comment the tag content is ignored.
see tag licenseText
Below XML has been validated against latest svd.xsd.
How to reproduce:
use svd_parser;
fn main() {
let xml=r#"<?xml version="1.0" encoding="utf-8"?>
<device schemaVersion="1.1" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="svd.xsd">
<name>ARM_Example</name>
<series>ARMCM3</series>
<version>1.2</version>
<description>SVD Test for Rust PAC generator</description>
<licenseText><!-- this license text will appear in header file. \n force line breaks --> Test license\n </licenseText>
<cpu>
<!-- details about the cpu embedded in the device -->
<name>CM3</name>
<revision>r1p0</revision>
<endian>little</endian>
<mpuPresent>true</mpuPresent>
<fpuPresent>false</fpuPresent>
<nvicPrioBits>3</nvicPrioBits>
<vendorSystickConfig>false</vendorSystickConfig>
</cpu>
<addressUnitBits>8</addressUnitBits>
<width>32</width>
<size>32</size>
<access>read-write</access>
<resetValue>0x00000000</resetValue>
<resetMask>0xFFFFFFFF</resetMask>
<peripherals>
<peripheral>
<name>UART</name>
<baseAddress>0x50000000</baseAddress>
<registers>
<register>
<name>Reg1</name>
<addressOffset>0x0</addressOffset>
<resetMask>0xFFFFFFFF</resetMask>
</register>
</registers>
</peripheral>
</peripherals>
</device>
"#;
let device = svd_parser::parse(xml).unwrap();
println!("{:?}",device.license_text);
println!("{:?}",device.description);
}
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the svd_parser::parse entry point and reproduce the XML example containing a comment inside the licenseText tag. Check that parsing preserves the license text instead of ignoring the tag content, while the surrounding device data still parses successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100