Rebuilding phobos' ddox after a change
Vladimir Panteleev via Digitalmars-d
digitalmars-d at puremagic.com
Fri Sep 16 07:11:16 PDT 2016
On Friday, 16 September 2016 at 13:36:38 UTC, Andrei Alexandrescu
wrote:
> So I changed one file in phobos and then went to the dlang.org
> tree and issued "make". The old-style ddoc was rebuilt, but the
> ddox was not.
There are two issues here:
1. The dlang.org makefile does not know the full set of files in
Phobos, or how they map to .html files. Currently this is worked
around by a recursive make invocation (we invoke the Phobos
posix.mak and ask it to build the docs, if needed).
2. The makefiles do not know how Phobos .d files map to DDox
.html files. In fact, the Phobos makefile (which knows what the
Phobos .d files are) does not know anything about DDox at all.
Though, I believe that currently DDox gets all information from
DMD's .json output, which is obtained by globbing for *.d files
in the Phobos directory.
> I recall this has been an issue for a while now. What is a
> reasonable fix?
In theory, it would be possible to fix this by adding a DDox
feature to generate a Makefile include, which would represent the
mappings between .d files and generated .html files, similar to
rdmd's --makedepend.
> My only recourse right now is to issue "make clean; make",
> which is inefficient if I do it many times.
According to the makefile, deleting docs-prerelease.json should
force "make" to rebuild the DDox documentation.
More information about the Digitalmars-d
mailing list