0
Files
src/docs
Nate Fischer ae5fd322fd Docs: document target_cpu in Android steps
This updates Android build documentation for the `target_cpu` option,
and provides guidance for how to determine this value.

This setting is arm-by-default for Android development. Although this is
OK for Chrome for Android developers, it doesn't work for several
use-cases:

 * Doesn't work for WebView on arm64 devices (which are increasingly
   popular)
 * Doesn't work for tests on arm64 devices (e.g.,
   webview_instrumentation_apk)
 * Doesn't work for non-arm at all (e.g., x86-based emulator)

Although there's a low cost to setting `target_cpu`, there's a high cost
to omitting it (a mistake requires a full rebuild). And, since it's not
obvious when the default is insufficient, this provides guidance for how
to set it correctly for a given device.

This also changes from `gn gen --args` to `gn args`. The motivation is:

 * It's convenient to call out `target_cpu` with an inline comment
 * `gn args` is a convenient command for complex configs, and isn't
   significantly worse for the recommended simple config
 * IMO it's easier to find docs for `gn args` (`gn help args`) than
   `--args` (it's not obvious it's a global option, and lives under `gn
   help switches`)

This edits a bullet about default settings. Although it's true that
`target_os` and `target_cpu` default to `host_os` and `host_cpu`, this
is not relevant to Android development, since we always override these
values.

R=agrieve@chromium.org

Bug: 918221
Test: N/A
Change-Id: Ie4b8eab491fd8b860420dbba6dac6badc16b9f76
Reviewed-on: https://chromium-review.googlesource.com/c/1401981
Commit-Queue: Nate Fischer <ntfschr@chromium.org>
Reviewed-by: agrieve <agrieve@chromium.org>
Cr-Commit-Position: refs/heads/master@{#621936}
2019-01-11 07:33:18 +00:00
..
2018-06-20 11:00:06 +00:00
2018-08-22 21:52:02 +00:00
2018-06-27 18:53:50 +00:00
2018-10-09 19:46:36 +00:00
2018-08-02 17:14:55 +00:00
2018-05-08 16:27:49 +00:00
2018-07-09 18:39:53 +00:00

Chromium docs

This directory contains chromium project documentation in Gitiles-flavored Markdown. It is automatically rendered by Gitiles.

If you add new documents, please also add a link to them in the Document Index below.

[TOC]

Creating Documentation

Markdown documents must follow the style guide.

Preview local changes using md_browser:

# in chromium checkout
./tools/md_browser/md_browser.py

This is only an estimate. The gitiles view may differ.

  1. Upload a patch to gerrit, or receive a review request. e.g. https://chromium-review.googlesource.com/c/572236
  2. View a specific .md file. e.g. https://chromium-review.googlesource.com/c/572236/2/docs/README.md
  3. Click on gitiles link at top of page.

This gitiles view is the authoritative view, exactly the same as will be used when committed.

Document Index

Checking Out and Building

Design Docs

Integrated Development Environment (IDE) Set Up Guides

Git

Clang

General Development

Testing

Misc Linux-Specific Docs

Misc MacOS-Specific Docs

Misc Windows-Specific Docs

Misc Android-Specific Docs

Misc iOS-Specific Docs

Misc Chrome-OS-Specific Docs

Misc WebUI-Specific Docs

Media

Accessibility

Memory

Memory Infrastructure Timeline Profiling (MemoryInfra)

Misc

Probably Obsolete