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

Outdated run commands in GUIDE.md #691

Closed
developedby opened this issue Aug 21, 2024 · 1 comment · Fixed by #693
Closed

Outdated run commands in GUIDE.md #691

developedby opened this issue Aug 21, 2024 · 1 comment · Fixed by #693
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@developedby
Copy link
Member

Reproducing the behavior

In #630 we changed the default runtime to be the HVM C. The readme was updated, but GUIDE.md was not, and it still has the wrong commands.

Where it mentions the rust runtime, the command should be bend run-rs. bend run is now an alias to bend run-c.

We should also have a look at the other documents to see if there's anything that still mentions the wrong commands.

System Settings

Bend commit bd592ca

Additional context

No response

@developedby developedby added bug Something isn't working documentation Improvements or additions to documentation labels Aug 21, 2024
@thiagola92
Copy link

I'm confuse (just started reading README.md).

This is the expected behavior, right?

bend run    <file.bend> # uses the C interpreter by default (parallel)
bend run-rs <file.bend> # uses the Rust interpreter (sequential)
bend run-c  <file.bend> # uses the C interpreter (parallel)
bend run-cu <file.bend> # uses the CUDA interpreter (massively parallel)

So this needs to be updated, right?

Bend/README.md

Lines 120 to 128 in 71fb680

You can run it using Rust interpreter (Sequential)
```sh
bend run sequential_sum.bend -s
```
Or you can run it using C interpreter (Sequential)
```sh
bend run-c sequential_sum.bend -s
```

This could be updated to "run-rs" avoid confusion but would require changing others place, right?

Bend/src/main.rs

Lines 291 to 296 in 71fb680

let run_cmd = match &cli.mode {
Mode::RunC(..) => "run-c",
Mode::RunRs(..) => "run",
Mode::RunCu(..) => "run-cu",
_ => "run-c",
};

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants