Skip to content

Commit

Permalink
Update basic Fuchsia building docs
Browse files Browse the repository at this point in the history
Bug: None
Change-Id: I721c75e75ae0ec95667749f673578221747cbbea
Reviewed-on: https://chromium-review.googlesource.com/1244156
Commit-Queue: Scott Graham <scottmg@chromium.org>
Reviewed-by: Sergey Ulanov <sergeyu@chromium.org>
Cr-Commit-Position: refs/heads/master@{#594085}
  • Loading branch information
sgraham authored and Commit Bot committed Sep 25, 2018
1 parent 6b4ccf3 commit 6b17c65
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 12 deletions.
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ used when committed.
(on a Linux host)
* [Cast for Android Build Instructions](android_cast_build_instructions.md) -
Cast for Android (on a Linux host)
* [Fuchsia Build Instructions](fuchsia_build_instructions.md) - Fuchsia target
(on a Linux host)
* [iOS Build Instructions](ios/build_instructions.md) - iOS target (on a MacOS
host)
* [Chrome OS Build Instructions](chromeos_build_instructions.md) - Chrome OS
Expand Down
40 changes: 28 additions & 12 deletions docs/fuchsia_build_instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
***Note that the Fuchsia port is in the early stages, and things are likely to
frequently be broken. Try #cr-fuchsia on Freenode if something seems awry.***

There are instructions for other platforms linked from the
There are instructions for other platforms linked from the
[get the code](get_the_code.md) page.

## System requirements
Expand Down Expand Up @@ -49,9 +49,6 @@ dependencies.
$ fetch --nohooks chromium
```

If you don't want the full repo history, you can save a lot of time by
adding the `--no-history` flag to `fetch`.

Expect the command to take 30 minutes on even a fast connection, and many
hours on slower ones.

Expand All @@ -74,15 +71,40 @@ target_os = ['fuchsia']
Note that this should be added as a top-level statement in the `.gclient` file,
not an entry inside the `solutions` dict.

You will then need to re-run `gclient runhooks`. This makes sure the Fuchsia SDK
is available in third\_party and keeps it up to date.
You will then need to run:

```shell
$ gclient runhooks
```

This makes sure the Fuchsia SDK is available in third\_party and keeps it up to
date.

The remaining instructions assume you have switched to the `src` directory:

```shell
$ cd src
```

### Update your checkout

To update an existing checkout, you can run

```shell
$ git rebase-update
$ gclient sync
```

The first command updates the primary Chromium source repository and rebases
any of your local branches on top of tip-of-tree (aka the Git branch
`origin/master`). If you don't want to use this script, you can also just use
`git pull` or other common Git commands to update the repo.

The second command syncs dependencies to the appropriate versions and re-runs
hooks as needed. `gclient sync` updates dependencies to the versions specified
in `DEPS`, so any time that file is modified (pulling, changing branches, etc.)
`gclient sync` should be run.

## (Mac-only) Download additional required Clang binaries

Go to [this page](https://chrome-infra-packages.appspot.com/p/fuchsia/clang/mac-amd64/+/)
Expand Down Expand Up @@ -136,9 +158,3 @@ Common gtest arguments such as `--gtest_filter=...` are supported by the run
script.

The run script also symbolizes backtraces.

A useful alias (for "Build And Run Filtered") is:
```shell
alias barf='ninja -C out/fuchsia net_unittests -j1000 && out/fuchsia/bin/run_net_unittests --test-launcher-filter-file=../../testing/buildbot/filters/fuchsia.net_unittests.filter'
```
to build and run only the tests that are not excluded/known-failing on the bot.
1 change: 1 addition & 0 deletions docs/get_the_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ you might want to build:
* [Android](android_build_instructions.md)
* [Android Cast](android_cast_build_instructions.md)
* [Chrome OS](chromeos_build_instructions.md)
* [Fuchsia](fuchsia_build_instructions.md)
* [iOS](ios/build_instructions.md)
* [Linux](linux_build_instructions.md)
* [Linux Cast](linux_cast_build_instructions.md)
Expand Down

0 comments on commit 6b17c65

Please sign in to comment.