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

Clarify how to run a locally built mirai. #525

Merged

Conversation

stonebuddha
Copy link
Contributor

@stonebuddha stonebuddha commented May 28, 2020

Description

The "Running" section of the developer guide has mixed instructions for using both a locally built binary and a globally installed binary, on both a single file (as rustc) and a crate (via cargo).
It also seems unnecessary to have instructions for globally installed binary, because they are covered somewhere else, and a developer just needs the locally built one during development.

This commit separates the instructions for single files from those for crates, updates all the commands to use a locally built binary, and tweaks the indentation in debug configurations.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • API change with a documentation update
  • Additional test coverage
  • Code cleanup or just keeping up with the latest Rustc nightly

None of the above: only documentation change.

How Has This Been Tested?

Followed the instructions to build and run locally built mirai on both single files and crates.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 28, 2020
@hermanventer
Copy link
Collaborator

I presume that you have actually carried out the process documented by this. If so, that is your test plan. If not, please do so.

@stonebuddha
Copy link
Contributor Author

I presume that you have actually carried out the process documented by this. If so, that is your test plan. If not, please do so.

Yeah, I've followed the process on my machine. I'll update the test plan.

@hermanventer hermanventer merged commit a563e65 into facebookexperimental:master May 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants