Enhanced cvdr.md documentation #483
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Asquator
requested review from
Databean,
adelva1984,
jemoreira,
jmacnak,
rmuthiah and
ser-io
as code owners
jemoreira
left a comment
jemoreira
left a comment
There was a problem hiding this comment.
Thank you for your contribution! The documentation is certainly more useful now.
I left some minor comments, we can merge the PR once you have addressed them and signed the Google CLA (see comment from the review bot).
|
|
||
|
|
||
| ```bash | ||
| CVDR_USER_CONFIG_PATH=/path/to/cvdr.toml ./cvdr --help |
There was a problem hiding this comment.
We should also make cvdr try to read config files from the default locations when the variables are not defined.
| export ANDROID_BUILD_TOP=/path/to/your/AOSP/sources/root | ||
| export ANDROID_PRODUCT_OUT="${ANDROID_BUILD_TOP}/out/target/product/your_target" | ||
| ``` | ||
| Replace the latter with the your `OUT_DIR` if you override it. |
| export ANDROID_BUILD_TOP=/path/to/your/AOSP/sources/root | ||
| export ANDROID_PRODUCT_OUT="${ANDROID_BUILD_TOP}/out/target/product/your_target" |
There was a problem hiding this comment.
You shouldn't define these variables yourself, but let the android build system define them for you by running lunch $MY_BUILD_TARGET
|
|
||
| <br> | ||
|
|
||
| To automatically fetch the [required images](https://cs.android.com/android/platform/superproject/+/master:device/google/cuttlefish/required_images) from your AOSP root and create an instance, please run: |
There was a problem hiding this comment.
nit: We typically use "fetch" when referring to images built in a build server remotely. For this case, please rewrite it as "To create an instance using the [build artifacts](link here) from your local AOSP repo, please run"
Added expected result output for successful build.
2 participants
Enhanced cvdr documentation, made it more ad-hoc to newcomers:
As a newcomer, it was pretty difficult to get along with the command without reading the code. I think the env vars were not documented at all. Created this PR to make it easier for other people.