Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed broken deploy script due to multiline configuration docs #7385

Merged
merged 1 commit into from
Jun 21, 2021

Conversation

xFrednet
Copy link
Member

The deploy script on master currently runs into an error (See log) due to the new configuration documentation added in #7299. The current documentation collection for the configuration macro sadly doesn't support multiline doc comments. This will be changes in the future with the new metadata collector tracked in #7172 For now we have to use <br> inside doc comments to add paragraphs.

This PR restricts define_Conf! macro to single lines and adds a comment explaining the reasoning behind it. It also adjusted the actual document parsing to fix a bug. (The parsing was automatically stopping on the first curly bracket, even if it was part of a doc comment).

changelog: none

@rust-highfive
Copy link

r? @phansch

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Jun 20, 2021
@xFrednet
Copy link
Member Author

r? @flip1995 Could you maybe review this PR 🙃

@rust-highfive rust-highfive assigned flip1995 and unassigned phansch Jun 20, 2021
@@ -91,7 +91,7 @@ def parse_configs(path):
contents = fp.read()

match = re.search(conf_re, contents)
confvars = re.findall(confvar_re, match.group(1))
confvars = re.findall(confvar_re, match.group(0))
Copy link
Member Author

Choose a reason for hiding this comment

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

This used to reference the second group as the previous regex also match with the macro_rules! define_Conf { part.

@flip1995
Copy link
Member

@bors r+

Thanks! (I really have to make some time to get the metadata collector through)

@bors
Copy link
Collaborator

bors commented Jun 21, 2021

📌 Commit 96a9786 has been approved by flip1995

@bors
Copy link
Collaborator

bors commented Jun 21, 2021

⌛ Testing commit 96a9786 with merge 86bf28d...

@bors
Copy link
Collaborator

bors commented Jun 21, 2021

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: flip1995
Pushing 86bf28d to master...

@bors bors merged commit 86bf28d into rust-lang:master Jun 21, 2021
@xFrednet xFrednet deleted the 0000-fix-broken-deploy branch July 28, 2021 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants