Modernize dcompiler documentation#2290
Conversation
|
Thanks for your pull request, @wilzbach! Bugzilla referencesYour PR doesn't reference any Bugzilla issue. If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog. |
|
|
||
| $(OL | ||
| $(LI $(LINK2 https://dlang.org/download.html, Download D Compiler)) | ||
| $(LI $(LINK2 https://dlang.org/download.html, DMD Compiler)) |
There was a problem hiding this comment.
D compiler might be confusing, because this documentation is about DMD and not every D compiler.
Also Download is already in title and it's marked as a link, but I only feel strongly about using DMD.
| ) | ||
| $(FREEBSD | ||
| $(LI 32 bit x86 FreeBSD 7.1 operating system) | ||
| $(LI 32 bit x86 and 64 bit x86-64 FreeBSD operating system (11 or later)) |
There was a problem hiding this comment.
There was a problem hiding this comment.
You can put comments in the .dd file by putting them inside $(COMMENT my illuminating explanation) which expands to nothing.
There was a problem hiding this comment.
Oh that comment was just intended as a help for the reviewers, s.t. it's clear why I made this change.
| $(WINDOWS | ||
| $(MESSAGE_BOX gray, $(B Hint) - The official $(LINK2 $(ROOT_DIR)download.sh, installer) | ||
| performs these steps automatically. | ||
| ) |
There was a problem hiding this comment.
This documentation is also displayed via e.g. -man and linked from the release pages, so chances are actually very high that the user has already installed DMD and just looks for a documentation of the CLI flags.
There was a problem hiding this comment.
That install script requires a posix/bash environment, and I suspect most Windows users don't have that.
| $(P Linking 64 bit programs is done using the | ||
| Microsoft linker. | ||
| Microsoft linker by default. If the Microsoft linker is not found, | ||
| the included LLVM linker LLD will be used. |
There was a problem hiding this comment.
| make -f win32.mak | ||
| cd ..\phobos | ||
| make -f win32.mak DMD=$(DMDDIR)\$(OS)\bin\dmd | ||
| make -f win32.mak |
There was a problem hiding this comment.
| make -f posix.mak DMD=~/$(DMDDIR)/$(OS)/bin/dmd | ||
| cd ../phobos | ||
| make -f posix.mak DMD=~/$(DMDDIR)/$(OS)/bin/dmd | ||
| make -f posix.mak |
There was a problem hiding this comment.
DRuntime is built automatically since a few months (though currently the source can't be built - https://forum.dlang.org/post/bmfzbxcmwuhcduldjtdx@forum.dlang.org)
dcompiler.dd
Outdated
| of cross-module optimizations, such as function inlining across modules. | ||
| ) | ||
| $(P The $(D -i) flag can be used to let $(B dmd) automatically search and compile | ||
| all depending source files.) |
There was a problem hiding this comment.
The text above talks about:
dmd can build an executable much faster if as many of the source files as possible are put on the command line.
Well, nowadays that's no longer necessary with -i (though I wasn't sure on the wording or if we should modify the existing paragraph.
There was a problem hiding this comment.
I suggest the following wording instead:
$(P The $ (D -i) flag can be used to automatically compile imported modules)
|
Addressed the review. Can we get this merged? |
Ping. |
wilzbach
added
the
72h no objection -> merge
4 participants
A few small improvements to the respective dmd.html files.