Skip to content

Conversation

@wilzbach
Copy link
Contributor

Individual commits:

  • Remove duplicated id.d from FRONT_SRCS (It's already part of LEXER_SRCS)
  • Add new 'style' target to check for Ddoc errors
  • Run style target on CircleCi
  • Fix DDoc warnings

@dlang-bot
Copy link
Contributor

dlang-bot commented Dec 13, 2017

Thanks for your pull request, @wilzbach!

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
Member

Shouldn't DAutoTest already (be able to) enforce DDoc warnings?

@wilzbach
Copy link
Contributor Author

Shouldn't DAutoTest already (be able to) enforce DDoc warnings?

Unfortunately is -de effectless on Ddoc warnings.
We do the same thing as part of the style target @ Phobos:

https://github.com/dlang/phobos/blob/master/posix.mak#L591

The idea is that this check can be run without needing to clone dlang.org
It's also a chicken-egg problem if we want to avoid even more complex Makefile rules at DAutotest, as we e.g. druntime doesn't have this check at all and here it still will take a bit until it is in stable (aka part of a release).

@CyberShadow
Copy link
Member

-de is for deprecations, did you mean -w?

@CyberShadow
Copy link
Member

It's also a chicken-egg problem if we want to avoid even more complex Makefile rules at DAutotest, as we e.g. druntime doesn't have this check at all and here it still will take a bit until it is in stable (aka part of a release).

Yeah but it's wasted work because the documentation is going to be built anyway...

@wilzbach wilzbach force-pushed the style branch 2 times, most recently from d3e3bd1 to 4f924e5 Compare December 15, 2017 11:25
@wilzbach
Copy link
Contributor Author

Yeah but it's wasted work because the documentation is going to be built anyway...

Ah I see what you are going for. Fair enough. Done.

Copy link
Member

@CyberShadow CyberShadow left a comment

Choose a reason for hiding this comment

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

Thanks, makefile stuff looks good. Can't judge correctness of the new documentation though.

@wilzbach
Copy link
Contributor Author

Thanks, makefile stuff looks good.

Ah I realized that -w doesn't trigger a halt, which makes it rather pointless :/
I opened a PR to fix it (-> #7440), but as we still use 2.072.2 for dlang.org, that's not a solution for now.
Thus I added a grep to the Makefile documentation target. There was also an -of- which lead to src/- being generated. I replaced it with the proper -o-

@CyberShadow
Copy link
Member

but as we still use 2.072.2 for dlang.org

Huh? DAutoTest builds DMD then uses it to build everything else, no?

@wilzbach
Copy link
Contributor Author

Huh? DAutoTest builds DMD then uses it to build everything else, no?

Yes and no - $(STABLE_DMD) is used to build the documentation.

@wilzbach
Copy link
Contributor Author

$(STABLE_DMD) is used to build the documentation.

See also: dlang/dlang.org#1926

@wilzbach
Copy link
Contributor Author

Removed the controversial grep to check for deprecation errors and added -w instead to unblock this PR. As of now -w is defunct, but #7440 will hopefully take care of this soon.

@wilzbach wilzbach force-pushed the style branch 4 times, most recently from b3afd6a to 48b3852 Compare December 21, 2017 10:26
@wilzbach
Copy link
Contributor Author

but #7440 will hopefully take care of this soon.

This is in - so we are good to go here (:

but as we still use 2.072.2 for dlang.org

Okay. I now changed the documentation build to use the currently build DMD. After all, dlang.org already passes DMD to the respective Makefile. So it can be easily overridden if needed. Also using an ancient version of Ddoc means that none of the bugs fixed in the Ddoc build will propagate to dlang.org.
DRuntime and Phobos use the latest version of DMD to build the documentation already (see https://github.com/wilzbach/druntime/blob/master/posix.mak#L152 and https://github.com/wilzbach/phobos/blob/udflags/posix.mak#L93).

- HOST_DMD is too old to build the documentation.
- This also fixes the problem of the file src/- being writing by the
documentation build.
@wilzbach
Copy link
Contributor Author

BTW as this PR changes the compiler we use to build the docs, this will fix e.g. this recently introduced page:

Online:

image

https://dlang.org/phobos-prerelease/dmd_semantic2.html


With this PR

image

@dlang-bot dlang-bot merged commit e4211a9 into dlang:master Dec 30, 2017
@wilzbach wilzbach deleted the style branch January 5, 2018 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants