Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add a note about how to consume DenoRT #1189

Closed
wants to merge 1 commit into from

Conversation

irbull
Copy link
Contributor

@irbull irbull commented Nov 24, 2024

Add documentation about how to consume DenoRT when building Deno from source.

Fixes: denoland/deno#27035

Add documentation about how to consume DenoRT when building Deno from
source.

Fixes: denoland/deno#27035
@@ -244,3 +244,19 @@ version instead of fetching it from `crates.io`.
`Cargo.toml` match the version of the dependencies you have on disk.

Use `cargo search <dependency_name>` to inspect the versions.

## Consuming the DenoRT
Copy link
Member

@dsherret dsherret Nov 24, 2024

Choose a reason for hiding this comment

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

Instead of needing to document this and for people to do this (which they probably will likely not read/remember this), it might be nice for this to automatically happen when running deno compile from a target/... directory.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've not seen the RFC for this, but this was in the comments of get_base_binary:

    // Phase 2 of the 'min sized' deno compile RFC talks
    // about adding this as a flag.

Having it automatically use the compiled DenoRT when the path includes target/ seems like The principle of least surprise. That seems better than both the flag & env variable approach. I will often sym link my debug build into /Users/irbull/.cargo/bin/deno, and maybe we can also handle this case.

If you're interested, I could take a stab at this. I don't have too much time today to dive into it, but I could find some time this week.

Copy link
Member

Choose a reason for hiding this comment

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

For sure!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had a bit of time today between kids sports, so I brought my laptop to the rink and put this PR together: denoland/deno#27052

I'll close this one.

@irbull irbull closed this Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to build & consume a custom DenoRT
2 participants