Merge Unix and Windows build systems in the ocamldoc directory by shindere · Pull Request #808 · ocaml/ocaml

shindere · 2016-09-13T15:50:56Z

This PR continues the build-systems merging work started in PRs
#762, #764, #785 and #788.

Here again, the aim is to make ocamldoc/Makefile work for both
Unix and Windows, so that ocamldoc/Makefile.nt can just include it.

So, although this PR improves a few aspects of the build process of ocamldoc
(see commit log for details of those improvements and changes), it is
worth emphasizing that improving the build process itself is not the primary
target of this PR, whose goal is, again, to merge the build systems.

alainfrisch · 2016-09-13T20:54:52Z

ocamldoc/Makefile

+ifeq "$(UNIX_OR_WIN32)" "unix"
+OCAMLDEPFLAGS =
+else # Windows
+OCAMLDEPFLAGS = -slash


It seems -slash does nothing under Unix, so one might be able to avoid this conditional.

Alain Frisch (2016/09/13 13:54 -0700):

+OCAMLDEP = $(OCAMLRUN) $(ROOTDIR)/tools/ocamldep
+ifeq "$(UNIX_OR_WIN32)" "unix"
+OCAMLDEPFLAGS =
+else # Windows
+OCAMLDEPFLAGS = -slash

It seems -slash does nothing under Unix,

Indeed (I chekced). Many thanks for having spotted this.

so one might be able to avoid this conditional.

Doone.

This commit changes the behaviour of both the Unix and Windows build systems. The changes are either specific to one build system or common to both. Changes specific to the Unix build system: - Use the -slash option when invoking ocamldep. This does nothing on Unix and makes it possible to use the same command under Unix and Windows. - install target: - Directories are created unconditionnally, instead of creating them only if they do not already exist (also true for the installopt target) - cp no longer uses the -f flag, to be consistent with the other directories - The custom directory $(INSTALL_LIBDIR)/custom is no longer created because nothing was installed there anyway - In the opt.opt target, consecutive calls to make have been replaced by prerequisites, enhancing parallelisation opportunities. Changes specific to the Windows build system: - Whaen compiling .ml files, use the same line-number-preserving preprocessor as under Unix, rather than the grep -v DEBUG command. - ocamldoc generators and odoc_test are now compiled - ocamldoc can now be run from sources to generate the documentation of the standard library - The test targets are now also available under Windows - opt.opt now builds native-code versions of the generators Changes affecting both Unix and Windows build systems: - The targets that were depending on the empty "dummy" target are now declared as .PHONY targets, dummy has been removed. - In the all target, successive calls to make have been replaced by prerequisites. - Commands executed by make clean are now displayed instead of being executed silently.

gasche · 2016-09-15T06:10:51Z

As a meta comment: you have been doing a lot of excellent work on deduplicating and improving the compiler distribution build system, in a series of distinct pull requests. Very few of those changes had a Changes entry giving credit for your work.

I think it is probably time for a comprehensive Changes entry that is global in scope (it corresponds to the work of sharing Unix and Windows Makefile across the whole compiler distribution). I think it would be best if it listed all affected directories (in case there is a regression somewhere, users can find the mention of the problematic directory in the changelog), and give the PR numbers of each.

shindere · 2016-09-15T07:56:52Z

Thanks, Gabriel. I think the current plan regarding changes (as discussed with @alainfrisch I don't remember where) is to add one global item for everything when the build systems have been merged everywhere. Currently, three directories remain where the build systems have not yet been completely merged, where "completely merged" means that the only thing Makefile.nt does is to include the Makefile. I hope the build systems in these directories can be merged in the next days. Then, it should become possible to do exactly the same thing in the main makefiles to finally get rid of all the Makfile.nt files.

alainfrisch · 2016-10-31T17:40:12Z

I've found a problem with this PR, related to calling the bytecode executable ocamldoc under Windows. Even if the PATH is extended with explicit paths to otherlibs/win32unix and otherlibs/str, ocamlrun will still look up the stub dlls in the installation directory first, as can be seen by setting OCAMLRUNPARAM=v=256.

If another version was installed in the same target directory before, the old dlls will be loaded which can lead to failure (e.g. I just got "Fatal error: unknown C primitive 'unix_lstat'").

A fix could be to set:

CAML_LD_LIBRARY_PATH="../otherlibs/win32unix;../otherlibs/str"

instead of changing PATH.

@shindere Do you think this is the right thing to do?

alainfrisch · 2016-11-09T23:04:23Z

Ping @shindere . @dra27 : also interested in your opinion about the note above.

shindere · 2016-11-10T10:18:23Z

Very sorry about the delay @alainfrisch, I didn't see your last comment. In principle I pretty much like your suggestion, because in addition to solving the problem you describe, it avoids modifying a very generic variable which affects many things (PATH), in favour of a dedicated variable whose semantics is much clearer (at least to me). I suggest that I test this fix on our Windows machines and then submit another PR. Is that fine? I am also interested in your feedback, @dra27.

@alainfrisch

This fixes a problem related to the way ocamldoc's bytecode executable is called under Windows, reported by @alainfrisch at ocaml#808 (comment) As he explains, ``Even if the PATH is extended with explicit paths to otherlibs/win32unix and otherlibs/str, ocamlrun will still look up the stub dlls in the installation directory first, as can be seen by setting OCAMLRUNPARAM=v=256. If another version was installed in the same target directory before, the old dlls will be loaded which can lead to failure (e.g. I just got "Fatal error: unknown C primitive 'unix_lstat'"). A fix could be to set: CAML_LD_LIBRARY_PATH="../otherlibs/win32unix;../otherlibs/str" instead of changing PATH''. This commit implements the proposed fix, due to @alainfrisch.

@alainfrisch

This fixes a problem related to the way ocamldoc's bytecode executable is called under Windows, reported by @alainfrisch at ocaml#808 (comment) As he explains, ``Even if the PATH is extended with explicit paths to otherlibs/win32unix and otherlibs/str, ocamlrun will still look up the stub dlls in the installation directory first, as can be seen by setting OCAMLRUNPARAM=v=256. If another version was installed in the same target directory before, the old dlls will be loaded which can lead to failure (e.g. I just got "Fatal error: unknown C primitive 'unix_lstat'"). A fix could be to set: CAML_LD_LIBRARY_PATH="../otherlibs/win32unix;../otherlibs/str" instead of changing PATH''. This commit implements the proposed fix, due to @alainfrisch.

shindere · 2016-11-10T11:09:38Z

PR #906 has just been submitted to fix the reported issue. It has been tested on both MinGW and MSVC ports and seems to work.

@alainfrisch

This fixes a problem related to the way ocamldoc's bytecode executable is called under Windows, reported by @alainfrisch at ocaml#808 (comment) As he explains, ``Even if the PATH is extended with explicit paths to otherlibs/win32unix and otherlibs/str, ocamlrun will still look up the stub dlls in the installation directory first, as can be seen by setting OCAMLRUNPARAM=v=256. If another version was installed in the same target directory before, the old dlls will be loaded which can lead to failure (e.g. I just got "Fatal error: unknown C primitive 'unix_lstat'"). A fix could be to set: CAML_LD_LIBRARY_PATH="../otherlibs/win32unix;../otherlibs/str" instead of changing PATH''. This commit implements the proposed fix, due to @alainfrisch.

@alainfrisch

…#906) This fixes a problem related to the way ocamldoc's bytecode executable is called under Windows, reported by @alainfrisch at #808 (comment) As he explains, ``Even if the PATH is extended with explicit paths to otherlibs/win32unix and otherlibs/str, ocamlrun will still look up the stub dlls in the installation directory first, as can be seen by setting OCAMLRUNPARAM=v=256. If another version was installed in the same target directory before, the old dlls will be loaded which can lead to failure (e.g. I just got "Fatal error: unknown C primitive 'unix_lstat'"). A fix could be to set: CAML_LD_LIBRARY_PATH="../otherlibs/win32unix;../otherlibs/str" instead of changing PATH''. This commit implements the proposed fix, due to @alainfrisch.

…#808) This commit changes the behaviour of both the Unix and Windows build systems. The changes are either specific to one build system or common to both. Changes specific to the Unix build system: - Use the -slash option when invoking ocamldep. This does nothing on Unix and makes it possible to use the same command under Unix and Windows. - install target: - Directories are created unconditionnally, instead of creating them only if they do not already exist (also true for the installopt target) - cp no longer uses the -f flag, to be consistent with the other directories - The custom directory $(INSTALL_LIBDIR)/custom is no longer created because nothing was installed there anyway - In the opt.opt target, consecutive calls to make have been replaced by prerequisites, enhancing parallelisation opportunities. Changes specific to the Windows build system: - Whaen compiling .ml files, use the same line-number-preserving preprocessor as under Unix, rather than the grep -v DEBUG command. - ocamldoc generators and odoc_test are now compiled - ocamldoc can now be run from sources to generate the documentation of the standard library - The test targets are now also available under Windows - opt.opt now builds native-code versions of the generators Changes affecting both Unix and Windows build systems: - The targets that were depending on the empty "dummy" target are now declared as .PHONY targets, dummy has been removed. - In the all target, successive calls to make have been replaced by prerequisites. - Commands executed by make clean are now displayed instead of being executed silently.

@alainfrisch

…ocaml#906) This fixes a problem related to the way ocamldoc's bytecode executable is called under Windows, reported by @alainfrisch at ocaml#808 (comment) As he explains, ``Even if the PATH is extended with explicit paths to otherlibs/win32unix and otherlibs/str, ocamlrun will still look up the stub dlls in the installation directory first, as can be seen by setting OCAMLRUNPARAM=v=256. If another version was installed in the same target directory before, the old dlls will be loaded which can lead to failure (e.g. I just got "Fatal error: unknown C primitive 'unix_lstat'"). A fix could be to set: CAML_LD_LIBRARY_PATH="../otherlibs/win32unix;../otherlibs/str" instead of changing PATH''. This commit implements the proposed fix, due to @alainfrisch.

signal_alloc testcase fix

… to_cmm (ocaml#808)

shindere mentioned this pull request Sep 13, 2016

Merge makefiles in otherlibs/systhreads #785

Merged

shindere force-pushed the merge-ocamldoc-makefiles branch from 139f11c to 9aeef95 Compare September 13, 2016 16:05

alainfrisch reviewed Sep 13, 2016
View reviewed changes

shindere force-pushed the merge-ocamldoc-makefiles branch 3 times, most recently from 38c85d7 to e913ca4 Compare September 14, 2016 08:30

shindere mentioned this pull request Sep 14, 2016

Merge build systems in the tools subdirectory #812

Merged

shindere force-pushed the merge-ocamldoc-makefiles branch from e913ca4 to c5c4835 Compare September 14, 2016 14:03

shindere force-pushed the merge-ocamldoc-makefiles branch from c5c4835 to d51851a Compare September 14, 2016 14:28

alainfrisch merged commit 28f91df into ocaml:trunk Sep 14, 2016

shindere deleted the merge-ocamldoc-makefiles branch September 15, 2016 08:03

shindere mentioned this pull request Nov 10, 2016

Fix the way the ocamldoc bytecode executable is called under Windows. #906

Merged

gasche mentioned this pull request Dec 29, 2016

Merge build systems in the byterun directory #981

Merged

ctk21 pushed a commit to ocaml-multicore/ocaml that referenced this pull request Dec 21, 2021

Merge pull request ocaml#808 from Engil/signals_alloc_reenable

b8f77a8

signal_alloc testcase fix

stedolan pushed a commit to stedolan/ocaml that referenced this pull request Sep 21, 2022

Register boxed numbers as structured constants in cmmgen_state during…

f393310

… to_cmm (ocaml#808)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge Unix and Windows build systems in the ocamldoc directory#808

Merge Unix and Windows build systems in the ocamldoc directory#808
alainfrisch merged 1 commit intoocaml:trunkfrom
shindere:merge-ocamldoc-makefiles

shindere commented Sep 13, 2016

Uh oh!

alainfrisch Sep 13, 2016

Uh oh!

shindere Sep 14, 2016

Uh oh!

gasche commented Sep 15, 2016

Uh oh!

shindere commented Sep 15, 2016 via email

Uh oh!

alainfrisch commented Oct 31, 2016

Uh oh!

alainfrisch commented Nov 9, 2016 •

edited

Loading

Uh oh!

shindere commented Nov 10, 2016 via email

Uh oh!

shindere commented Nov 10, 2016 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

shindere commented Sep 13, 2016

Uh oh!

alainfrisch Sep 13, 2016

Choose a reason for hiding this comment

Uh oh!

shindere Sep 14, 2016

Choose a reason for hiding this comment

Uh oh!

gasche commented Sep 15, 2016

Uh oh!

shindere commented Sep 15, 2016 via email

Uh oh!

alainfrisch commented Oct 31, 2016

Uh oh!

alainfrisch commented Nov 9, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shindere commented Nov 10, 2016 via email

Uh oh!

shindere commented Nov 10, 2016 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alainfrisch commented Nov 9, 2016 •

edited

Loading