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.

Sign up for GitHub

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

Jump to bottom

Description of rti-image #227

Merged
merged 2 commits into from
Jan 31, 2024
Merged

Description of rti-image #227

merged 2 commits into from
Jan 31, 2024

Conversation

lhstrh
Copy link
Member

@lhstrh lhstrh commented Jan 31, 2024

No description provided.

@lhstrh lhstrh requested a review from cmnrd January 31, 2024 07:29
cmnrd
cmnrd approved these changes Jan 31, 2024
View reviewed changes
Copy link
Contributor

@cmnrd cmnrd left a comment

Choose a reason for hiding this comment

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

Looks good!

@cmnrd
Copy link
Contributor

cmnrd commented Jan 31, 2024

I removed the mention of lfc-dev. I see the handbook as user facing, and we don't need to mention dev tools there. The developers, however, should know that they can use lfc-dev as a replacement for lfc.

@cmnrd cmnrd merged commit 2194310 into main Jan 31, 2024
2 checks passed
@cmnrd cmnrd deleted the docker-rti branch January 31, 2024 09:32
@edwardalee
Copy link
Contributor

I removed the mention of lfc-dev. I see the handbook as user facing, and we don't need to mention dev tools there. The developers, however, should know that they can use lfc-dev as a replacement for lfc.

Don't we have a Developer section of the handbook?

edwardalee
edwardalee reviewed Jan 31, 2024
View reviewed changes
docs/reference/containerized-execution.mdx
Comment on lines +113 to +124
### Select an RTI
By default, an image is pulled from DockerHub that contains the RTI. An alternative image can be specified using the `rti-image` entry as follows:

```lf-c
target C {
docker: {rti-image: "lflang/rti:latest"}
}
```

:::note
To use a local image that is based on source of the RTI provided by `lfc`, use `rti-image: "lflang/rti:rti"`.
:::
Copy link
Contributor

Choose a reason for hiding this comment

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

This does not explain what rti-image: local means. Also, what is meant by "source of the RTI provided by lfc"? Does lfc' provide source? Also, the syntax lflang/rti:rti` is pretty arcane. What does this mean?

@cmnrd
Copy link
Contributor

cmnrd commented Jan 31, 2024

Don't we have a Developer section of the handbook?

Yes, but all other parts are user facing. lfc-dev should be mentioned and explained in the developer section. Elsewhere, there should be no need to explicitly mention lfc-dev.

@lhstrh lhstrh mentioned this pull request Jan 31, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@edwardalee edwardalee edwardalee left review comments

@cmnrd cmnrd cmnrd approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lhstrh @cmnrd @edwardalee