Add a source-root arg to html-generate #982
Merged
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
The relative path has already been given when the .cmt was originally compiled, so to avoid having to pass it again this argument allows the root directory of the source tree to be passed, and then odoc finds the actual source file by looking up that relative file within the tree.
panglesd
approved these changes
Jul 31, 2023
src/odoc/html_page.ml
Outdated
Comment on lines
19
to
26
| type source = File of Fpath.t | Root of Fpath.t | ||
|
|
||
| let pp fmt = function | ||
| | File f -> Format.fprintf fmt "File: %a" Fpath.pp f | ||
| | Root f -> Format.fprintf fmt "File: %a" Fpath.pp f | ||
|
|
||
| let to_string f = Format.asprintf "%a" pp f | ||
|
|
There was a problem hiding this comment.
Maybe this could be put inside a submodule? The Html_page.to_string and Html_page.pp names can be misleading, as they are not function dealing with "html pages"...
src/odoc/bin/main.ml
Outdated
Comment on lines
735
to
736
| "Source code root for the compilation unit. It must have been compiled \ | ||
| with --source-parent passed." |
There was a problem hiding this comment.
I feel it might help to add some explanation what is a "source code root".
Suggested change
| "Source code root for the compilation unit. It must have been compiled \ | |
| with --source-parent passed." | |
| "Source code root for the compilation unit. Used to find the source file \ | |
| from the value of --source-name it was compiled with. Incompatible with \ | |
| --source-file." |
Also, line 718 it should be --source-parent-file instead of --source-parent (or maybe "--source-parent-file and --source-name to be more explicit)
Suggested by @panglesd.
|
Thanks @panglesd - applied. |
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.
The relative path has already been given when the .cmt was originally compiled, so to avoid having to pass it again this argument allows the root directory of the source tree to be passed, and then odoc finds the actual source file by looking up that relative file within the tree.