Skip to content

Insert the actual ddoc file containing predefined macros instead of d…#1805

Merged
andralex merged 1 commit intodlang:masterfrom
andralex:ddoc
Aug 4, 2017
Merged

Insert the actual ddoc file containing predefined macros instead of d…#1805
andralex merged 1 commit intodlang:masterfrom
andralex:ddoc

Conversation

@andralex
Copy link
Copy Markdown
Member

@andralex andralex commented Jul 6, 2017

…uplicating it

Automation FTW.

@dlang-bot
Copy link
Copy Markdown
Contributor

Thanks for your pull request, @andralex!

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

@CyberShadow
Copy link
Copy Markdown
Member

Duplicate of #1703 ?

@andralex
Copy link
Copy Markdown
Member Author

andralex commented Jul 7, 2017

Looks like a superset. I'd say we either pull this, or remove the content from the doc page and replace it with a link to the actual file.

@CyberShadow
Copy link
Copy Markdown
Member

I think an earlier version of #1703 did pretty much what this does, but not the current diff.

@wilzbach
Copy link
Copy Markdown
Contributor

wilzbach commented Jul 7, 2017

Btw if we go with #1688, we could easily insert the exact file from DMD here and avoid it getting outdated in the future.

@andralex
Copy link
Copy Markdown
Member Author

andralex commented Aug 3, 2017

Push this and close #1703?

@andralex
Copy link
Copy Markdown
Member Author

andralex commented Aug 3, 2017

Rebased. Let's take action on this soon lest it's liable to rot every time something changes in the ddoc default - which is what it's supposed to :)

@andralex
Copy link
Copy Markdown
Member Author

andralex commented Aug 3, 2017

It doesn't preclude a more radical approach a la #1688 but it does make progress while we mull over that.

@CyberShadow
Copy link
Copy Markdown
Member

Essentially I don't think we should put that huge DDoc template in our specs. It's huge, likely to change (as it's stylistic in nature), and overshadows the definitions that one might actually look at.

I've said this before, and IMO the default DDoc template change wasn't done as well as it could have. The built-in definitions should have stayed unchanged; instead, the compiler could the include an additional .ddoc file by default, that's available separately.

spec/ddoc.src.dd Outdated
ESCAPES = /$(LT)/$(AMP)lt;/
/$(GT)/$(AMP)gt;/
/$(AMP)/$(AMP)amp;/
3fc0f638fb1ab1bad2e01f507b968324
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Where is this coming from? A Git hash or a random set of characters?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I generated it with mcookie. The idea is it's a unique string to be replaced with the actual text.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I see, thanks.

@andralex
Copy link
Copy Markdown
Member Author

andralex commented Aug 4, 2017

I agree that the default macro definitions should be implementation-defined. I've reworked this diff to mention that, and also added the idea in #1703 to it.

@CyberShadow
Copy link
Copy Markdown
Member

I agree that the default macro definitions should be implementation-defined.

Good call. LGTM.

@andralex andralex merged commit cd3a65f into dlang:master Aug 4, 2017
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.

5 participants