0

docs: enlarge the title used by the ios-build-instructions page

This patch makes the title of ios_build_instructions.md match with
the other two (mac_build_instructions.md and linux_build_instructions.md).

It also reorders/rewords the title so it matches with the Mac one.

This patch also changes the headings to use "##" rather than "____" as that is what is recommended by the style guide at https://github.com/google/styleguide/blob/gh-pages/docguide/style.md#atx-style-headings.

BUG=None
R=sdefresne@chromium.org

Review URL: https://codereview.chromium.org/1755133002

Cr-Commit-Position: refs/heads/master@{#378755}
This commit is contained in:
tfarina
2016-03-02 08:02:50 -08:00
committed by Commit bot
parent 86c19a63c9
commit f0dd080efb

@@ -1,12 +1,11 @@
### Build Instructions (iOS) # iOS Build Instructions
**Note:** Upstreaming of iOS code is still a work in progress. In particular, **Note:** Upstreaming of iOS code is still a work in progress. In particular,
note that **it is not currently possible to build an actual Chromium app.** note that **it is not currently possible to build an actual Chromium app.**
Currently, the buildable binaries are ios\_web\_shell (a minimal wrapper around Currently, the buildable binaries are ios\_web\_shell (a minimal wrapper around
the web layer), and various unit tests. the web layer), and various unit tests.
Prerequisites ## Prerequisites
-------------
- A Mac with a version of OS X capable of running the latest version - A Mac with a version of OS X capable of running the latest version
of Xcode. of Xcode.
@@ -15,8 +14,7 @@ Prerequisites
- The current version of the JDK (required for the closure compiler). - The current version of the JDK (required for the closure compiler).
- [depot\_tools](http://dev.chromium.org/developers/how-tos/install-depot-tools). - [depot\_tools](http://dev.chromium.org/developers/how-tos/install-depot-tools).
Setting Up ## Setting Up
----------
In the directory where you are going to check out the code, create a In the directory where you are going to check out the code, create a
`chromium.gyp_env` to set the build to use iOS targets (and to use `chromium.gyp_env` to set the build to use iOS targets (and to use
@@ -46,8 +44,7 @@ EOF
Also, you should [install API Also, you should [install API
keys](https://www.chromium.org/developers/how-tos/api-keys). keys](https://www.chromium.org/developers/how-tos/api-keys).
Getting the Code ## Getting the Code
----------------
Next, [check out the Next, [check out the
code](https://www.chromium.org/developers/how-tos/get-the-code), with: code](https://www.chromium.org/developers/how-tos/get-the-code), with:
@@ -56,8 +53,7 @@ code](https://www.chromium.org/developers/how-tos/get-the-code), with:
fetch ios fetch ios
``` ```
Building ## Building
--------
Build the target you are interested in. The instructions above select Build the target you are interested in. The instructions above select
the ninja/Xcode hybrid mode, which uses ninja to do the actual build, the ninja/Xcode hybrid mode, which uses ninja to do the actual build,
@@ -79,8 +75,7 @@ target you want to build.
You should always be able to build All, since targets are added there for iOS You should always be able to build All, since targets are added there for iOS
only when they compile. only when they compile.
Running ## Running
-------
Any target that is built and runs on the bots (see [below](#Troubleshooting)) Any target that is built and runs on the bots (see [below](#Troubleshooting))
should run successfully in a local build. As of the time of writing, this is should run successfully in a local build. As of the time of writing, this is
@@ -95,8 +90,7 @@ example, to run a debug build of ios\_web\_shell:
out/Debug-iphonesimulator/iossim out/Debug-iphonesimulator/ios_web_shell.app out/Debug-iphonesimulator/iossim out/Debug-iphonesimulator/ios_web_shell.app
``` ```
Converting an existing Mac checkout into an iOS checkout ## Converting an existing Mac checkout into an iOS checkout
--------------------------------------------------------
If you want to convert your Mac checkout into an iOS checkout, you can If you want to convert your Mac checkout into an iOS checkout, you can
follow those steps: follow those steps:
@@ -123,8 +117,7 @@ files according to the new settings.
gclient sync gclient sync
``` ```
Troubleshooting ## Troubleshooting
---------------
If your build fails, check the iOS columns of [the Mac If your build fails, check the iOS columns of [the Mac
waterfall](http://build.chromium.org/p/chromium.mac/console) (the last waterfall](http://build.chromium.org/p/chromium.mac/console) (the last