Upgrade ddox by wilzbach · Pull Request #1891 · dlang/dlang.org

wilzbach · 2017-09-10T02:46:15Z

This is WIP and at least gets dpl-docs compiling with ddox 0.16.
I opened this PR to (ab)use DAutoTest a bit - sorry for the noise.

dlang-bot · 2017-09-10T02:46:17Z

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.

wilzbach · 2017-09-10T03:22:53Z

This is WIP and at least gets dpl-docs compiling with ddox 0.16.

Finally got even the search working again. Should be good to go now - let's see what DAutoTest has to say.

PetarKirov · 2017-09-10T08:37:42Z

dpl-docs/views/ddox.inc.module-tree.dt

-	- if (auto pp = cast(Package)pack.parent)
-		- return pp.lookup!Module(pack.name);
-	- return null;
-


Why remove?

Because it's defined in ddox.inc.utils.dt which is now in this scope too.

PetarKirov · 2017-09-10T08:39:50Z

dpl-docs/views/ddox.overview.dt

 			- moduleInfoRec(p);
 		- foreach( m; pack.modules )
-			- if (!m.qualifiedName.startsWith("std.c.") && !m.qualifiedName.startsWith("core.stdc.") && !m.qualifiedName.startsWith("core.sys."))
+			- auto qualifiedName = m.qualifiedName.to!string;


Why is .to!string necessary? .startsWith should work with any string.

wilzbach · 2017-09-10T22:51:06Z

dpl-docs/views/layout.dt

                ul
                  li
-                    a(href="#{root_dir}spec/spec.html")Language Reference
+                    a(href="#{root_dir}spec/spec.html") Language Reference


Newer Diet versions enforce a whitespace before the text.

wilzbach · 2017-09-10T22:52:47Z

dpl-docs/views/inc.disqus.dt

    var disqus_shortname = 'vibe-d'; // required: replace example with your forum shortname
    var disqus_developer = 1;
-    var disqus_identifier = #{"\\\"phobos-" ~ info.node.qualifiedName ~ "\\\""};
+    var disqus_identifier = #{text(`"phobos-`, info.node.qualifiedName.text, `"`)};


info.node.qualifiedName was converted to a range (and isn't a string anymore)

wilzbach · 2017-09-10T22:53:40Z

dpl-docs/views/ddox.layout.dt

 	block ddox.title

 block navigation
+	include ddox.inc.utils


heading has been moved in this auxiliary file: https://github.com/rejectedsoftware/ddox/blob/8ceb3815552765630e9fa0dece63f35837d416ee/views/ddox.inc.utils.dt

wilzbach · 2017-09-14T01:24:25Z

Sadly due to a change in diet-ng, ddox now produces compact HTML, so the entire diff is unusable.
As far as I can see, we have two options:

manually check a few page & merge
wait for add --html-style option ddox#166

wilzbach · 2017-09-14T21:09:11Z

wait for dlang/ddox#166

Thanks to @s-ludwig's fast reaction time, the PR got in and has been applied for this PR, s.t. the diff hopefully will be small.
Afterwards in a follow-up PR, I will then switch from pretty-printing to compact in a new separate PR.

wilzbach · 2017-09-21T22:59:20Z

, s.t. the diff hopefully will be small.

Sadly it's not due to other changes in the rendering of diet-ng
We could do the upgrade in yet another PR or simply move on with this.
@CyberShadow @ZombineDev what do you prefer?

wilzbach · 2017-10-05T17:32:23Z

@CyberShadow @ZombineDev what do you prefer?

Friendly ping ;-)

CyberShadow · 2017-10-05T18:57:22Z

Friendly ping ;-)

IIRC the CI was failing at the time of your previous comment.

Still, this does not look right:

+									<a id="MemoryOrder" class="[&quot;public&quot;]" href="../core/atomic/memory_order.html">MemoryOrder</a>

CyberShadow · 2017-10-05T18:59:05Z

There are a lot of whitespace changes, which make it difficult to find the other kinds.

Is it possible to split this into two or three PRs, one of which bumps past just the commits which introduce the whitespace changes? Or, more generally, one PR per ddox change which affects generated content would be even better.

wilzbach · 2017-10-05T20:53:13Z

Is it possible to split this into two or three PRs, one of which bumps past just the commits which introduce the whitespace changes? Or, more generally, one PR per ddox change which affects generated content would be even better.

Tried to only bump diet-ng or vibe-d -> no changes.
However, when I bump ddox 0.15.18 to 0.16.0, we get the full load again:

#1902

(this PR doesn't include the compactHTML - false change).

Any other ideas?
CC @s-ludwig

s-ludwig · 2017-10-08T14:33:51Z

We could of course make a PR that runs the output through some HTML formatter (e.g. "tidy", which is included in the Debian repositories), once for the current version and once for the new one.

class="["public"]"

Good catch, that is a silent behavior change in diet-ng vs the old implementation. I kind of lean towards keeping the semantics and fixing it in Ddox, tough (dlang/ddox#171). I'll try to get to fixing the recently discovered issues ASAP.

wilzbach · 2017-12-05T00:38:57Z

We could of course make a PR that runs the output through some HTML formatter (e.g. "tidy", which is included in the Debian repositories), once for the current version and once for the new one.

-> #1940 (but it would be a lot easier if we find the problems directly).

Good catch, that is a silent behavior change in diet-ng vs the old implementation. I kind of lean towards keeping the semantics and fixing it in Ddox, tough (dlang/ddox#171).

I submitted both options as PRs: rejectedsoftware/diet-ng#41 and dlang/ddox#187.

wilzbach · 2017-12-24T15:40:58Z

Good catch, that is a silent behavior change in diet-ng vs the old implementation. I kind of lean towards keeping the semantics and fixing it in Ddox, tough (dlang/ddox#171).
I submitted both options as PRs: rejectedsoftware/diet-ng#41 and dlang/ddox#187.

@s-ludwig we are still blocked on the Ddox regression for this update. Which PR do you prefer?

wilzbach · 2017-12-27T15:59:18Z

Okay I took one file in the DDox, applied tidy to both versions and then compared it. I observed the following changes:

the order of attributes changed in diet-ng (e.g. before: <body id="core.atomic" class="std">, after: <body class="std" id="core.atomic">)
arguments are now displayed (e.g. <span class="decoration">(here, ifThis, writeThis)</span>) - this is a very nice improvement

So imho everything looks good now and I think we are finally ready to upgrade.
@CyberShadow what do you think?

CyberShadow

¯\(ツ)/¯

MartinNowak · 2018-01-16T23:48:00Z

Nice, thanks for the effort. Gave it a shot myself, but it was quite tedious.

dlang-bot added the WIP label Sep 10, 2017

wilzbach force-pushed the upgrade-ddox branch 2 times, most recently from 08a291c to 9ddd84f Compare September 10, 2017 03:17

wilzbach changed the title ~~[WIP] Upgrade ddox~~ Upgrade ddox Sep 10, 2017

wilzbach removed the WIP label Sep 10, 2017

PetarKirov reviewed Sep 10, 2017

View reviewed changes

wilzbach force-pushed the upgrade-ddox branch 3 times, most recently from 0fcfd05 to 8613e35 Compare September 10, 2017 22:55

wilzbach commented Sep 10, 2017

View reviewed changes

wilzbach mentioned this pull request Sep 14, 2017

add --html-style option dlang/ddox#166

Merged

wilzbach force-pushed the upgrade-ddox branch from 8613e35 to bd788e2 Compare September 14, 2017 21:03

wilzbach mentioned this pull request Oct 5, 2017

Bump diet-ng to 1.1.0 #1902

Closed

This was referenced Dec 3, 2017

Bump stable DMD and DUB version #1926

Merged

Reformat HTML with Tidy #1940

Closed

wilzbach force-pushed the upgrade-ddox branch from 10f0b34 to bd788e2 Compare December 5, 2017 00:41

wilzbach force-pushed the upgrade-ddox branch from bd788e2 to 91eb693 Compare December 27, 2017 13:44

Upgrade dpl-docs to Ddox 0.16

33195fc

wilzbach force-pushed the upgrade-ddox branch from 91eb693 to 33195fc Compare December 27, 2017 15:31

CyberShadow approved these changes Dec 27, 2017

View reviewed changes

wilzbach merged commit 369319a into dlang:master Dec 27, 2017

wilzbach deleted the upgrade-ddox branch December 27, 2017 18:05

wilzbach mentioned this pull request Jan 4, 2018

Remove legacy Ddox pretty printing #2054

Merged

This was referenced Jan 16, 2018

[DOC] Minor update to minElement example dlang/phobos#6035

Merged

Cherry-pick 1891 + 1926 from master to stable #2089

Merged

wilzbach mentioned this pull request Mar 31, 2018

Remove compatibility --html-style=pretty flag #2317

Merged

Uh oh!

Comments

Conversation

wilzbach commented Sep 10, 2017

Uh oh!

dlang-bot commented Sep 10, 2017

Bugzilla references

Uh oh!

wilzbach commented Sep 10, 2017

Uh oh!

PetarKirov Sep 10, 2017

Choose a reason for hiding this comment

Uh oh!

wilzbach Sep 10, 2017

Choose a reason for hiding this comment

Uh oh!

PetarKirov Sep 10, 2017

Choose a reason for hiding this comment

Uh oh!

wilzbach Sep 10, 2017

Choose a reason for hiding this comment

Uh oh!

wilzbach Sep 10, 2017

Choose a reason for hiding this comment

Uh oh!

wilzbach Sep 10, 2017

Choose a reason for hiding this comment

Uh oh!

wilzbach commented Sep 14, 2017

Uh oh!

wilzbach commented Sep 14, 2017

Uh oh!

wilzbach commented Sep 21, 2017

Uh oh!

wilzbach commented Oct 5, 2017

Uh oh!

CyberShadow commented Oct 5, 2017

Uh oh!

CyberShadow commented Oct 5, 2017

Uh oh!

wilzbach commented Oct 5, 2017

Uh oh!

s-ludwig commented Oct 8, 2017

Uh oh!

wilzbach commented Dec 5, 2017

Uh oh!

wilzbach commented Dec 24, 2017

Uh oh!

wilzbach commented Dec 27, 2017

Uh oh!

CyberShadow left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MartinNowak commented Jan 16, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

CyberShadow left a comment •

edited

Loading