Skip to content

Unify DDoc Makefile build variables#1687

Merged
dlang-bot merged 1 commit intodlang:masterfrom
wilzbach:unify_ddoc_vars
Jun 9, 2017
Merged

Unify DDoc Makefile build variables#1687
dlang-bot merged 1 commit intodlang:masterfrom
wilzbach:unify_ddoc_vars

Conversation

@wilzbach
Copy link
Contributor

@wilzbach wilzbach commented Jun 9, 2017

Ideally this should cleanup our Ddoc variables mess. It's noteworthy that Druntime uses completely different ones, so the idea is to change the build files at Druntime afterwards.

If I did it right, no changes should be detected by DAutoTest.

@wilzbach wilzbach force-pushed the unify_ddoc_vars branch 2 times, most recently from dd8f3e6 to 19e894c Compare June 9, 2017 14:35
posix.mak Outdated
#

include osmodel.mak
PWD=$(realpath .)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The idea here to get rid of all the repeated realpath clutter

Copy link
Member

Choose a reason for hiding this comment

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

realpath resolves symlinks and unnecessarily exposes implementation details in log files or even built files. We should get rid of it and just use $(pwd) instead.


################################################################################
# Ddoc build variables
################################################################################
Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we agree on renaming _STABLE to _LATEST, this should be changed as well.
However without #1689 it the naming is stable...

${MAKE} --directory=${DRUNTIME_DIR} -f posix.mak target doc \
${MAKE} --directory=${DRUNTIME_DIR} -f posix.mak target doc $(DDOC_VARS_HTML) \
DOCDIR=${DOC_OUTPUT_DIR}/phobos-prerelease \
DOCFMT="$(addprefix `pwd`/, $(STD_DDOC_PRE))"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

dlang/druntime#1834 changes DOCDIR and DOCFMT to their more common names. After the next release (2.074.2), these lines can be removed for all druntime doc targets.

@wilzbach
Copy link
Contributor Author

wilzbach commented Jun 9, 2017

@realpath resolves symlinks and unnecessarily exposes implementation details in log files or even built files. We should get rid of it and just use $(pwd) instead.

You mean $(shell pwd), right?
Done.

@CyberShadow
Copy link
Member

Thanks!

Cloning into '/dev/shm/dtest/work/repo/dlang.org/../phobos-2.074.1'...

Looks like there's still a readlink somewhere...

@dlang-bot dlang-bot merged commit 670e3c5 into dlang:master Jun 9, 2017
@wilzbach wilzbach deleted the unify_ddoc_vars branch June 9, 2017 16:18
@wilzbach
Copy link
Contributor Author

The term DDOC_VARS_STABLE doesn't relate to DDOC_VARS_HTML and DDOC_VARS_VERBATIM.
Following the existing naming schemas, it prolly should be named DDOC_VARS_HTML_STABLE,

#1714

@MartinNowak
Copy link
Member

You also added a subtle breakage, now this makefiles requires any DMD or such variables to be absolute, while previously could deal well with relative paths.


../%-${DUB_VER} :
git clone --depth=1 -b v${DUB_VER} ${GIT_HOME}/$* $@
$(PWD)/%-${DUB_VER} :
Copy link
Member

Choose a reason for hiding this comment

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

Furthermore this broke the clone targets, they are located at $(PWD)/../%-${LATEST}.

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.

4 participants

Comments