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

Update the Target Description web page #298

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

chanijjani
Copy link

@chanijjani chanijjani commented Nov 20, 2024

Copy link
Member

@lhstrh lhstrh left a comment

Choose a reason for hiding this comment

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

What do the curly brackets do?

- Update the Rust target document parts.

Signed-off-by: Chanhee Lee <[email protected]>
@chanijjani
Copy link
Author

What do the curly brackets do?

I intended to leave the parts as backups but just dropped them for clarification.

Copy link
Member

@lhstrh lhstrh left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for these changes, @chanijjani!

Copy link
Member

@lhstrh lhstrh left a comment

Choose a reason for hiding this comment

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

Actually, there is one thing missing here. These changes should also be reflected in the versioned docs. Could you add those to this PR as well?

@chanijjani
Copy link
Author

chanijjani commented Nov 25, 2024

Rust target description validation

  • Example and method used
    : Run the binary of CounterProgram.lf after applying the target property and compiling with lfc (version: 0.9.0)
Target Property Supported (Web) Supported (Actual) Compilation & Execution Review Comment
auth, build, compiler, docker, files, no-runtime-validation, protobufs, runtime-version, scheduler X X N/A None
buildtype O O O None
(Binary size: Debug=40,671,312bytes
Release=4,450,760bytes
RelWithDebInfo=27,350,408bytes
MinSizeRel=4,179,936bytes)
cargo-dependencies, fast, no-compile, single-file-project, single-threaded, timeout, workers, Command-Line Arguments O O O None
cargo-features O O O It would be good to add usage examples later.
external-runtime-path O O X Not able to know how to use
export-dependency-graph X X X This option works only when cargo-features is set to cli and the command line option --export-graph is given.
logging X O O Check later
rust-include O O O Not able to know how to use

Signed-off-by: Chanhee Lee <[email protected]>
@chanijjani
Copy link
Author

@lhstrh Would the above table be enough for the versioned documents? Or could you let me share a guide for the documents?

@lhstrh
Copy link
Member

lhstrh commented Nov 25, 2024

I'm not sure what you mean, @chanijjani, but what I'm asking for is to simply replicate the changes you made in this PR across the files in the versioned_docs directory. At a minimum, v0.9.0 should reflect these changes. If we don't do this, the changes will only appear in the "nightly" docs, and I expect most people will be looking at the versioned docs.

@chanijjani
Copy link
Author

@lhstrh Oh, I understand. Let me do that immediately.

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.

2 participants