Skip to content

Fix escape char - #957

Open
Shriyans406 wants to merge 3 commits into
rust-embedded:masterfrom
Shriyans406:fix_escape_char
Open

Shriyans406 wants to merge 3 commits into
rust-embedded:masterfrom
Shriyans406:fix_escape_char

Conversation

@Shriyans406

Copy link
Copy Markdown

This PR ensures that characters like &, <, and > are escaped or avoided in SVD descriptions so that they don't break generated Rust docs

@Shriyans406
Shriyans406 requested a review from a team as a code owner April 21, 2026 17:39
Comment thread src/util.rs Outdated
escaped = escaped.replace('&', "&amp;");
}
if escaped.contains('<') {
escaped = escaped.replace('<', "&lt;");

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

svd string can contain valid html tags. How do you propose to process such cases?

@Shriyans406

Shriyans406 commented Apr 25, 2026 via email

Copy link
Copy Markdown
Author

@burrbull

Copy link
Copy Markdown
Member

I don't see any changes in this PR.

@Shriyans406

Shriyans406 commented Apr 27, 2026 via email

Copy link
Copy Markdown
Author

@Shriyans406

Copy link
Copy Markdown
Author

Added the required CHANGELOG.md entry and rebased the branch onto the latest master. The Changelog check now passes (success). Please review/merge when ready.

@Shriyans406

Copy link
Copy Markdown
Author

Hi all — bumping this old PR back into review.

The branch has since been rebased onto the latest master and the required
CHANGELOG.md entry has been added, so the required Changelog check now
passes (success).

This PR has been open for a while (>8 months) and is ready for review/merge
from the maintainers' side whenever convenient. Happy to provide any further
info needed.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants