Separate implementation and interface in different (odoc) compilation units #1067
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Note: the driver needs to be rewritten to use the new pipeline... |
|
This is ready for review. One notable change that can be discussed: the Instead, we just |
panglesd
added a commit
to panglesd/odoc
that referenced
this pull request
Jan 11, 2024
Hidden modules were not rendered, since calling html-generate on them was used to generate the associated source code. However, this breaks dune rules in some cases (see issue ocaml#1013), as dune always expect an output to the command. This fix is related to the separation of implementation and interface pipelines (see ocaml#1067). Signed-off-by: Paul-Elliot <[email protected]>
panglesd
force-pushed
the
separate-intf-impl
branch
from
322635e to
a368576
Compare
Julow
force-pushed
the
separate-intf-impl
branch
from
5cafdf3 to
830c4ed
Compare
Julow
approved these changes
Jan 18, 2024
Introduce a new command: `odoc compile-src`, which creates a new kind of odoc file: implementation files. Implementation files are used to render source code, as well as to collect occurrences. Signed-off-by: Paul-Elliot <[email protected]>
Signed-off-by: Paul-Elliot <[email protected]>
Signed-off-by: Paul-Elliot <[email protected]>
Signed-off-by: Paul-Elliot <[email protected]>
Signed-off-by: Paul-Elliot <[email protected]>
- Rename `--source-parent-file` into `parent` - Check that source argument is empty in case of rendering source tree - Removed now useless `syntax` argument from `extra_documents` - Check `"src-"`prefix when loading units for counting occurrences to avoid loading for nothing - fixed some typos and made some small refactoring Signed-off-by: Paul-Elliot <[email protected]>
panglesd
force-pushed
the
separate-intf-impl
branch
from
fd402d3 to
b7d5c1d
Compare
This field now hold one location instead of two. The name is now more explicit.
Signed-off-by: Paul-Elliot <[email protected]>
|
I rebased and marked the commands as experimental, as they are likely to change in the future (likely before we release)! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR separate the compilation pipeline for interface and implementation. This is a backward incompatible change, but only for rendering source code. It introduces a new command,
compile-src, which compiles to a new kind of odoc file: implementation files, namedsrc-<name>.odoc(l).A good way to see the changes is to look at the diff in the source rendering tests, but here is a list of the changes:
compilecommand do not take the--source-nameand--source-parent-filecommands.compile-srccommand take--source-pathand--source-parent-filecommand instead. It can only take a<name>.cmtfile as input, and creates a value of typeOdoc_model.Lang.Implementation.twhich is stored insrc-<name>.odoc. Basically, such type is a record containing an identifier, the source information extracted from the typedtree, the implementation shape and theuid_to_idmap.src-....odocfiles in the path.--sourceand--source-rootare restricted to implementationodoclfiles.A notable change is that
--source-parent-fileand--source-pathis required for implementation files, which forces to have them even when we only want to count occurrences, not render them.Another change is that
--sourceand--source-rootare not anymore specific to the html rendering process. The reason is that with the current organization of the code, only the renderer can depend on backend-specific flags, not the transformation model -> document. Of course it is possible to change that, but that require further modifications which I'm not sure we want.The reason for this change is the following:
.odoclgenerate files in very different output directories, which can be a problem for some build systems.