Skip to content

stdlib/Makefile: use list of modules from StdlibModules#8994

Merged
nojb merged 2 commits intoocaml:trunkfrom
nojb:stdlib_makefile_tweak
Sep 30, 2019
Merged

stdlib/Makefile: use list of modules from StdlibModules#8994
nojb merged 2 commits intoocaml:trunkfrom
nojb:stdlib_makefile_tweak

Conversation

@nojb
Copy link
Copy Markdown
Contributor

@nojb nojb commented Sep 29, 2019

This is a tweak in stdlib/Makefile to re-use the list of modules from stdlib/StdlibModules, so that there is one less spot that needs to be updated when adding a new stdlib module.

On the other hand, this means that the modules in stdlib/StdlibModules need to be listed in dependency order.

@dra27
Copy link
Copy Markdown
Member

dra27 commented Sep 29, 2019

Doesn't the manual depend on that list being in alphabetical order? (see note in stdlib/HACKING.adoc)? That said, why is spacetime at the top of the list?

@nojb
Copy link
Copy Markdown
Contributor Author

nojb commented Sep 29, 2019

Doesn't the manual depend on that list being in alphabetical order? (see note in stdlib/HACKING.adoc)? That said, why is spacetime at the top of the list?

Good question(s). I haven't checked but I would surprised if ocamldoc did not sort the names anyway. I will take a look tomorrow.

@dra27
Copy link
Copy Markdown
Member

dra27 commented Sep 29, 2019

I hope it's that the HACKING documentation is out-of-date, as it's an obvious code-quality improvement!

@Octachron
Copy link
Copy Markdown
Member

As far as I remember, the manual should be totally independent from the module order in StdlibModules. In particular, the ordering of the modules in the "Standard library" chapter is hard-coded in manual/manual/library/stdlib-blurb.etex.

@nojb
Copy link
Copy Markdown
Contributor Author

nojb commented Sep 30, 2019

I pushed a commit updating stdlib/HACKING.adoc. Anyone willing to make a decision on this PR?

@dra27
Copy link
Copy Markdown
Member

dra27 commented Sep 30, 2019

I’d already checked that the before and after lists were equivalent so if @Octachron is happy from the docs perspective, I’d say go for it!

@nojb
Copy link
Copy Markdown
Contributor Author

nojb commented Sep 30, 2019

OK, planning to merge once CI passes.

@gasche
Copy link
Copy Markdown
Member

gasche commented Sep 30, 2019

(@dra27 would you use the explicit "approve" mechanism?)

Copy link
Copy Markdown
Member

@dra27 dra27 left a comment

Choose a reason for hiding this comment

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

I was going to let Florian do that, but here is my magic seal 🙂

Copy link
Copy Markdown
Member

@Octachron Octachron left a comment

Choose a reason for hiding this comment

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

I can confirm that the manual is not affected by those changes.

@nojb nojb merged commit d942916 into ocaml:trunk Sep 30, 2019
@nojb nojb deleted the stdlib_makefile_tweak branch September 30, 2019 16:06
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