Fix mistakes in VPR Placement Constraints documentation #2112
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add missing close-tag and backslashes to example XML so that VPR accepts it, and correct the formatting so that the read_vpr_constraints option is displayed correctly.
|
Good catch -- thanks! |
|
Just saw this haha. Thanks for the fix-- it's been giving me grief as well! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This fixes a couple of mistakes in the VPR Placement Constraints documentation - the example constraints XML is now valid and accepted by VPR, and the
--read_vpr_constraintsoption is formatted as as a VPR option, whereas before an erroneous space led to unintended characters appearing.Related Issue
#2111
Motivation and Context
The example XML in the docs previously caused VPR to fail - if you're used to XML the cause is pretty obvious but otherwise it might cause a bit of confusion, so hopefully this can avoid that.
How Has This Been Tested?
The docs successfully build, and the HTML page renders as it should.
Types of changes
Checklist: