rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-12-23 23:12:52 +02:00
Code Issues Releases Activity
Files
f94a0398f0196547d622a6cadbcdb6f7202b0fd3
comprehensive-rust/src/android/setup.md

31 lines
853 B
Markdown
Raw Normal View History

Publish Comprehensive Rust 🦀
2022-12-21 16:36:30 +01:00
# Setup
Format all Markdown files with `dprint` (#1157) This is the result of running `dprint fmt` after removing `src/` from the list of excluded directories. This also reformats the Rust code: we might want to tweak this a bit in the future since some of the changes removes the hand-formatting. Of course, this formatting can be seen as a mis-feature, so maybe this is good overall. Thanks to mdbook-i18n-helpers 0.2, the POT file is nearly unchanged after this, meaning that all existing translations remain valid! A few messages were changed because of stray whitespace characters: msgid "" "Slices always borrow from another object. In this example, `a` has to remain " -"'alive' (in scope) for at least as long as our slice. " +"'alive' (in scope) for at least as long as our slice." msgstr "" The formatting is enforced in CI and we will have to see how annoying this is in practice for the many contributors. If it becomes annoying, we should look into fixing dprint/check#11 so that `dprint` can annotate the lines that need fixing directly, then I think we can consider more strict formatting checks. I added more customization to `rustfmt.toml`. This is to better emulate the dense style used in the course: - `max_width = 85` allows lines to take up the full width available in our code blocks (when taking margins and the line numbers into account). - `wrap_comments = true` ensures that we don't show very long comments in the code examples. I edited some comments to shorten them and avoid unnecessary line breaks — please trim other unnecessarily long comments when you see them! Remember we're writing code for slides :smile: - `use_small_heuristics = "Max"` allows for things like struct literals and if-statements to take up the full line width configured above. The formatting settings apply to all our Rust code right now — I think we could improve this with https://github.com/dprint/dprint/issues/711 which lets us add per-directory `dprint` configuration files. However, the `inherit: true` setting is not yet implemented (as far as I can tell), so a nested configuration file will have to copy most or all of the top-level file.
2023-12-31 00:15:07 +01:00
We will be using a Cuttlefish Android Virtual Device to test our code. Make sure
you have access to one or create a new one with:
Publish Comprehensive Rust 🦀
2022-12-21 16:36:30 +01:00
```shell
remove $ from code-blocks in other markdown files as well (#952) * remove $ from code blocks in translations * remove $ from code blocks in the other markdown files as well * Revert "remove $ from code blocks in the other markdown files as well" This reverts commit eda922dab93dd2d2967581650a5c983432ec3a80. * remove $ from code blocks in setup.md * re-added the previous changes * revert logging.md
2023-07-11 00:25:41 -04:00
source build/envsetup.sh
Update setup.md (#1519) ``` $ lunch aosp_cf_x86_64_phone-userdebug Invalid lunch combo: aosp_cf_x86_64_phone-userdebug Valid combos must be of the form <product>-<release>-<variant> ```
2023-11-30 05:36:42 -08:00
lunch aosp_cf_x86_64_phone-trunk_staging-userdebug
remove $ from code-blocks in other markdown files as well (#952) * remove $ from code blocks in translations * remove $ from code blocks in the other markdown files as well * Revert "remove $ from code blocks in the other markdown files as well" This reverts commit eda922dab93dd2d2967581650a5c983432ec3a80. * remove $ from code blocks in setup.md * re-added the previous changes * revert logging.md
2023-07-11 00:25:41 -04:00
acloud create
Publish Comprehensive Rust 🦀
2022-12-21 16:36:30 +01:00
```
Format all Markdown files with `dprint` (#1157) This is the result of running `dprint fmt` after removing `src/` from the list of excluded directories. This also reformats the Rust code: we might want to tweak this a bit in the future since some of the changes removes the hand-formatting. Of course, this formatting can be seen as a mis-feature, so maybe this is good overall. Thanks to mdbook-i18n-helpers 0.2, the POT file is nearly unchanged after this, meaning that all existing translations remain valid! A few messages were changed because of stray whitespace characters: msgid "" "Slices always borrow from another object. In this example, `a` has to remain " -"'alive' (in scope) for at least as long as our slice. " +"'alive' (in scope) for at least as long as our slice." msgstr "" The formatting is enforced in CI and we will have to see how annoying this is in practice for the many contributors. If it becomes annoying, we should look into fixing dprint/check#11 so that `dprint` can annotate the lines that need fixing directly, then I think we can consider more strict formatting checks. I added more customization to `rustfmt.toml`. This is to better emulate the dense style used in the course: - `max_width = 85` allows lines to take up the full width available in our code blocks (when taking margins and the line numbers into account). - `wrap_comments = true` ensures that we don't show very long comments in the code examples. I edited some comments to shorten them and avoid unnecessary line breaks — please trim other unnecessarily long comments when you see them! Remember we're writing code for slides :smile: - `use_small_heuristics = "Max"` allows for things like struct literals and if-statements to take up the full line width configured above. The formatting settings apply to all our Rust code right now — I think we could improve this with https://github.com/dprint/dprint/issues/711 which lets us add per-directory `dprint` configuration files. However, the `inherit: true` setting is not yet implemented (as far as I can tell), so a nested configuration file will have to copy most or all of the top-level file.
2023-12-31 00:15:07 +01:00
Please see the
[Android Developer Codelab](https://source.android.com/docs/setup/start) for
details.
More speaker notes about Android (#1501) Helps with https://github.com/google/comprehensive-rust/issues/1083
2023-11-28 11:19:04 -08:00
Be explicit that Android examples need a Git checkout (#2465) Without this, students will see subtle differences between what is on the slides and what we have in the code (see #2464 for an example).
2024-11-19 19:25:44 +01:00
The code on the following pages can be found in the
[`src/android/` directory](https://github.com/google/comprehensive-rust/tree/main/src/android)
of the course material. Please `git clone` the repository to follow along.
More speaker notes about Android (#1501) Helps with https://github.com/google/comprehensive-rust/issues/1083
2023-11-28 11:19:04 -08:00
<details>
Key points:
Format all Markdown files with `dprint` (#1157) This is the result of running `dprint fmt` after removing `src/` from the list of excluded directories. This also reformats the Rust code: we might want to tweak this a bit in the future since some of the changes removes the hand-formatting. Of course, this formatting can be seen as a mis-feature, so maybe this is good overall. Thanks to mdbook-i18n-helpers 0.2, the POT file is nearly unchanged after this, meaning that all existing translations remain valid! A few messages were changed because of stray whitespace characters: msgid "" "Slices always borrow from another object. In this example, `a` has to remain " -"'alive' (in scope) for at least as long as our slice. " +"'alive' (in scope) for at least as long as our slice." msgstr "" The formatting is enforced in CI and we will have to see how annoying this is in practice for the many contributors. If it becomes annoying, we should look into fixing dprint/check#11 so that `dprint` can annotate the lines that need fixing directly, then I think we can consider more strict formatting checks. I added more customization to `rustfmt.toml`. This is to better emulate the dense style used in the course: - `max_width = 85` allows lines to take up the full width available in our code blocks (when taking margins and the line numbers into account). - `wrap_comments = true` ensures that we don't show very long comments in the code examples. I edited some comments to shorten them and avoid unnecessary line breaks — please trim other unnecessarily long comments when you see them! Remember we're writing code for slides :smile: - `use_small_heuristics = "Max"` allows for things like struct literals and if-statements to take up the full line width configured above. The formatting settings apply to all our Rust code right now — I think we could improve this with https://github.com/dprint/dprint/issues/711 which lets us add per-directory `dprint` configuration files. However, the `inherit: true` setting is not yet implemented (as far as I can tell), so a nested configuration file will have to copy most or all of the top-level file.
2023-12-31 00:15:07 +01:00
- Cuttlefish is a reference Android device designed to work on generic Linux
desktops. MacOS support is also planned.
More speaker notes about Android (#1501) Helps with https://github.com/google/comprehensive-rust/issues/1083
2023-11-28 11:19:04 -08:00
Format all Markdown files with `dprint` (#1157) This is the result of running `dprint fmt` after removing `src/` from the list of excluded directories. This also reformats the Rust code: we might want to tweak this a bit in the future since some of the changes removes the hand-formatting. Of course, this formatting can be seen as a mis-feature, so maybe this is good overall. Thanks to mdbook-i18n-helpers 0.2, the POT file is nearly unchanged after this, meaning that all existing translations remain valid! A few messages were changed because of stray whitespace characters: msgid "" "Slices always borrow from another object. In this example, `a` has to remain " -"'alive' (in scope) for at least as long as our slice. " +"'alive' (in scope) for at least as long as our slice." msgstr "" The formatting is enforced in CI and we will have to see how annoying this is in practice for the many contributors. If it becomes annoying, we should look into fixing dprint/check#11 so that `dprint` can annotate the lines that need fixing directly, then I think we can consider more strict formatting checks. I added more customization to `rustfmt.toml`. This is to better emulate the dense style used in the course: - `max_width = 85` allows lines to take up the full width available in our code blocks (when taking margins and the line numbers into account). - `wrap_comments = true` ensures that we don't show very long comments in the code examples. I edited some comments to shorten them and avoid unnecessary line breaks — please trim other unnecessarily long comments when you see them! Remember we're writing code for slides :smile: - `use_small_heuristics = "Max"` allows for things like struct literals and if-statements to take up the full line width configured above. The formatting settings apply to all our Rust code right now — I think we could improve this with https://github.com/dprint/dprint/issues/711 which lets us add per-directory `dprint` configuration files. However, the `inherit: true` setting is not yet implemented (as far as I can tell), so a nested configuration file will have to copy most or all of the top-level file.
2023-12-31 00:15:07 +01:00
- The Cuttlefish system image maintains high fidelity to real devices, and is
the ideal emulator to run many Rust use cases.
More speaker notes about Android (#1501) Helps with https://github.com/google/comprehensive-rust/issues/1083
2023-11-28 11:19:04 -08:00
</details>
Reference in New Issue Copy Permalink