move res/ subdirectory to src/dmd/res/

[WalterBright]

Builds should not reference files up and out of the build directory and to the left.

[dlang-bot]

Thanks for your pull request, @WalterBright!

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.

Testing this PR locally

If you don't have a local development environment setup, you can use Digger to test this PR:

dub run digger -- build "master + dmd#11269"

[WalterBright]

CyberShadow/DAutoTest says:

Invalid source/import path: /dev/shm/dtest/work/repo/dmd/res

where is that path specified?

[Geod24]

dmd/dub.sdl

Line 74 in ca636dc

stringImportPaths "res"

[WalterBright]

Thanks @Geod24 as res is not greppable given it appears everywhere. I never would have found it on my own.

[Geod24]

Builds should not reference files up and out of the build directory and to the left.

Alternatively, I would say that build files should not be mixed with source files. Having makefiles and build.d in src has always irked me, but I think that's too late to change.

[WalterBright]

Thanks @Geod24 but there appears to be yet another one:

../dmd/generated/linux/release/64/dmd -J../dmd/res -J../dmd/generated/linux/release/64/ -c -o- -version=MARS -version=CoreDdoc \
	-version=StdDdoc -Df.generated/.prerelease-dummy.html \
	-Xf.generated/docs-prerelease.json -I../phobos @.generated/.prerelease-files.txt
../dmd/src/dmd/doc.d(364): Error: file `"default_ddoc_theme.ddoc"` cannot be found or not in a path specified with `-J`

[kubo39]

It seems unrelated to this failure, but I found one more case in ci.sh:test_dub_package.

"${build_path}/dmd" -version=NoBackend -version=GC -version=NoMain -Jgenerated/dub -Jres -Isrc -i -run test/dub_package/frontend.d

[WalterBright]

@kubo39 thanks, but where is that file? It's not in the dmd repository.

[kubo39]

@WalterBright
here:

dmd/ci.sh

Line 118 in 6ee0456

"${build_path}/dmd" -version=NoBackend -version=GC -version=NoMain -Jgenerated/dub -Jres -Isrc -i -run test/dub_package/frontend.d

[WalterBright]

thanks, trying it now

[WalterBright]

same failure :-(

[kubo39]

It seems here:
https://github.com/dlang/dlang.org/blob/e0f9c04e9dd4e2e41207711aa798b897ce4c7ac6/posix.mak#L755-L757

[WalterBright]

Thank you. Blocked by dlang/dlang.org#2821

[wilzbach]

If you want to merge dlang.org PR without duplication, you need to temporarily add both directories here as dlang.org uses dmd as a library:

stringImportPaths "res"
stringImportPaths "src/dmd/res"

[wilzbach]

Suggested change

	<StringImportPaths>../dmd/res;$(OutDir)</StringImportPaths>
	<StringImportPaths>..\dmd\res;$(OutDir)</StringImportPaths>

(similar for the changes below)

This is the Visual Studio project file, so I am pretty sure the Windows slashes should be kept.

[wilzbach]

Having makefiles and build.d in src has always irked me, but I think that's too late to change.

You're not only there. However, build.d isn't called directly by any CI (or packagers) yet, but only via the Makefiles.
So it would be possible to move build.d up to the root-level, adjust its paths and change the paths to build.d in the makefiles.
For full compatibility the src/build.d could print a deprecation message and execute sth. along: $DC -run <scriptDir>/../build.d <args>.

[MoonlightSentinel]

You're not only there.

Ditto

However, build.d isn't called directly by any CI (or packagers) yet, but only via the Makefiles.

dmd/.github/workflows/runnable_cxx.yml

Lines 274 to 280 in d263f80

	./dmd/src/build.d -j2 MODEL=64
	make -C druntime -f posix.mak -j2 MODEL=64
	make -C phobos -f posix.mak -j2 MODEL=64
	# Both version can live side by side (they end up in a different directory)
	# However, since clang does not provide a multilib package, only test 32 bits with g++
	if [ ${{ matrix.compiler }} == "g++" ]; then
	./dmd/src/build.d install -j2 MODEL=32

dmd/.circleci/run.sh

Lines 181 to 186 in d263f80

	./src/build.d clean
	rm -rf generated # just to be sure
	# TODO: add support for 32-bit builds
	./src/build.d MODEL=64
	./generated/linux/release/64/dmd --version | grep -v "dirty"
	./src/build.d clean

[wilzbach]

However, build.d isn't called directly by any CI (or packagers) yet, but only via the Makefiles.

Oh Thanks for the correction @MoonlightSentinel. I wasn't aware that we were already doing this, but as these files are still in the same repo + under our control, I guess it's a now or never decision, because I believe packagers will soon switch to use src/build.d directly and we want to make their version bumps as smooth as possible.

[wilzbach]

(restarted all CIs by force-pushing)

[wilzbach]

[13] [14] (/usr/share/texlive/texmf-dist/tex/latex/base/ts1cmtt.fd)
! You can't use `\spacefactor' in vertical mode.
\add@accent ...}\accent #1 #2\egroup \spacefactor 
                                                  \accent@spacefactor 
l.592     \t
            
? 
! Emergency stop.
\add@accent ...}\accent #1 #2\egroup \spacefactor 
                                                  \accent@spacefactor 
l.592     \t
            
!  ==> Fatal error occurred, no output PDF file produced!
Transcript written on .generated/dlangspec.log.
posix.mak:553: recipe for target '/dev/shm/dtest/work/repo/dlang.org/web/dlangspec.pdf' failed

@CyberShadow any ideas? I wasn't able to reproduce this locally. dlangspec.tex is the same for me with/without this PR.

[CyberShadow]

Oh, no. Not another PDF problem. 😞

I don't know what happened there. A random fluke?

[CyberShadow]

The cure: dlang/dlang.org#2823

[WalterBright]

Thanks everyone for the help with this! There are more files like this that need fixing, but I'm a bit battle fatigued at the moment and will do them later.