0
Commit Graph

20 Commits

Author SHA1 Message Date
michaeldo
8cccf2141e Move ios documentation from //docs to //docs/ios.
TBR=cmasso@chromium.org
BUG=none

Review-Url: https://codereview.chromium.org/2731293003
Cr-Commit-Position: refs/heads/master@{#454972}
2017-03-06 22:12:02 +00:00
sdefresne
9d63b30c1e Document how to build Chromium for devices.
Document how to build Chromium for devices, how to configure the
Code Signing Identity to use and which Mobile Provisioning Profile
are required to build Chromium and the tests for device.

BUG=694604

Review-Url: https://codereview.chromium.org/2712513003
Cr-Commit-Position: refs/heads/master@{#452459}
2017-02-23 11:24:51 +00:00
srikanthg
7b8d153f90 Fixes a documentation bug. Google employee? See go/building-chrome instead. text is repeated twice.
BUG=

Review-Url: https://codereview.chromium.org/2595233004
Cr-Commit-Position: refs/heads/master@{#440517}
2016-12-22 22:12:32 +00:00
rohitrao
80f35ea766 [ios] Updates docs to include build instructions for Chromium.app.
BUG=None

Review-Url: https://codereview.chromium.org/2597573003
Cr-Commit-Position: refs/heads/master@{#440209}
2016-12-21 21:02:27 +00:00
xiaoyin.l
1003c0bc03 Use HTTPS links for Google domains in docs
Since almost all Google domains support HTTPS, and it is a good practice to
use HTTPS wherever possible, thus in this patch, I changed most HTTP links
to https whose domains are known to support HTTPS well.

Modifications are generated by running these commands in src/docs directory:
sed -i 's/http:\/\/www.chromium.org/https:\/\/www.chromium.org/g' *.md
sed -i 's/http:\/\/developer.android.com/https:\/\/developer.android.com/g' *.md
sed -i 's/http:\/\/dev.chromium.org/https:\/\/dev.chromium.org/g' *.md
sed -i 's/http:\/\/build.chromium.org/https:\/\/build.chromium.org/g' *.md
sed -i 's/http:\/\/src.chromium.org/https:\/\/src.chromium.org/g' *.md
sed -i 's/http:\/\/crbug.com/https:\/\/crbug.com/g' *.md
sed -i 's/http:\/\/groups.google.com/https:\/\/groups.google.com/g' *.md
sed -i 's/http:\/\/cs.chromium.org/https:\/\/cs.chromium.org/g' *.md
sed -i 's/http:\/\/codereview.chromium.org/https:\/\/codereview.chromium.org/g' *.md

BUG=

Review-Url: https://codereview.chromium.org/2545363002
Cr-Commit-Position: refs/heads/master@{#436501}
2016-12-06 02:53:51 +00:00
dpranke
27ea3ce48e Remove links to old build instructions.
It looks like the new instructions are reasonably good, so I think
we can remove the old ones now.

R=thakis@chromium.org
BUG=670518

Review-Url: https://codereview.chromium.org/2544963002
Cr-Commit-Position: refs/heads/master@{#435817}
2016-12-02 01:49:34 +00:00
dpranke
1a70d0c93b More fixes to the build instructions.
This picks up various fixes noted by scottmg@chromium.org,
thakis@chromium.org, and Twitter user @florpelier, as well as a few
more things I wanted to clean up.

R=scottmg@chromium.org, thakis@chromium.org, sdy@chromium.org
BUG=

Review-Url: https://codereview.chromium.org/2543503004
Cr-Commit-Position: refs/heads/master@{#435533}
2016-12-01 02:46:09 +00:00
sdy
93387fa96a Make some small tweaks to the build instructions.
- Standardize on fenced code blocks, add 'shell' where appropriate.
- Add '$' to shell commands where missing.
- Add `code` marks to more identifiers.
- Minor stylistic/grammatical suggestions.

R=dpranke@chromium.org, teresam@google.com

Review-Url: https://codereview.chromium.org/2536723008
Cr-Commit-Position: refs/heads/master@{#435508}
2016-12-01 01:08:25 +00:00
dpranke
0ae7cad40a Update the build instructions to be consistent.
We have lots of inconsistencies between the different platforms in the
public instructions, and between the public instructions and the internal
instructions.

This CL (along with an internal one) should clean everything up.

TBR=teresam@google.com, sdy@chromium.org
NOTRY=true

Review-Url: https://codereview.chromium.org/2526563003
Cr-Commit-Position: refs/heads/master@{#435138}
2016-11-30 07:53:36 +00:00
sdefresne
7f4c25f2b5 Upstream helper script to build Chromium on iOS and update instructions.
Upstream some scripts used to simplify the setup of a new Chromium on iOS
checkout and update the instruction to remove obsolete informations, and
add recommendation to use the script.

BUG=None

Review-Url: https://codereview.chromium.org/2343853002
Cr-Commit-Position: refs/heads/master@{#419422}
2016-09-19 09:58:32 +00:00
patricialor
88a0fac96b Documentation: Update iOS build docs to include instructions for gn.
Review-Url: https://codereview.chromium.org/1904773003
Cr-Commit-Position: refs/heads/master@{#390250}
2016-04-28 00:17:56 +00:00
tfarina
f851b2c93e docs: codeblock within a list should be indented
According to the style guide a nested codeblock within a list, which is
the case we are changing here, should be indented, otherwise it will
break the numbering of the list, like it is now. Without this
indentation the numbering looks like: 1., 2., 1.. But that is just
wrong, and should be 1., 2., 3.. The indentation should restore the
right numbering here.

https://github.com/google/styleguide/blob/gh-pages/docguide/style.md#nest-codeblocks-within-lists

BUG=None
R=sdefresne@chromium.org

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

Cr-Commit-Position: refs/heads/master@{#381742}
2016-03-17 17:56:09 +00:00
tfarina
b7c6e4eb79 docs: copy the mac wording for installing api-keys over to ios instructions
The current wording says you 'should' install to build, but that is not
really true if you don't want to test some Google services and 'should'
sounds very strong.

The Mac version has nicer wording for directing users to install the API
keys if they want so we ported it over here.

BUG=None
R=sdefresne@chromium.org

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

Cr-Commit-Position: refs/heads/master@{#379885}
2016-03-08 19:30:19 +00:00
tfarina
b8922b4284 docs: fix the numbering in "Converting an existing Mac checkout" section
Due to the code block in the second item, the Markdown engine is not
smart enough to figure out that the next one is related to the other
items and thus should be '3' not '1'.

To fix this, we number the list ourselves rather than letting the Markdown
engine do this work for us.

BUG=None
TEST=load the document in http://dillinger.io/ before this change,
confirm it has the issue, then change it and confirm it has the right
numbering for the list.
R=sdefresne@chromium.org

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

Cr-Commit-Position: refs/heads/master@{#379590}
2016-03-07 18:26:11 +00:00
tfarina
b3456c7707 docs: less confusing sentence for running gclient sync command
This patch tries to clear the last paragraph of
"Converting-an-existing-Mac-checkout-into-an-iOS-checkout" section,
to be more to the point and slightly more accurate in the future.

Given that at some point into the not-so-distant future GN will replace
GYP, the word about "gyp_chromium" won't be necessarily true anymore.

It does not seem worth to mention this implementation detail of 'gclient
sync'.

BUG=None
R=sdefresne@chromium.org

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

Cr-Commit-Position: refs/heads/master@{#379332}
2016-03-04 19:37:12 +00:00
tfarina
f12dabb757 docs: for a unnumbered list use asterisks ('*')
This patch changes ios_build_instructions to use asterisk ('*')
rather than dash ('-') for a unnumbered or bullet list.

This make it conform with other files in the docs/ directory, like
mac_build_instructions.md and with the style guide:
https://github.com/google/styleguide/blob/gh-pages/docguide/style.md#nested-list-spacing

BUG=None
R=sdefresne@chromium.org

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

Cr-Commit-Position: refs/heads/master@{#379040}
2016-03-03 18:25:20 +00:00
tfarina
f0dd080efb 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}
2016-03-02 16:03:50 +00:00
sdefresne
bf9b6e83eb docs: Minor tweaks to docs/ios_build_instructions.md.
Add internal links (i.e. links to anchor) as the version of Markdown used
by gitiles generate anchors for each heading automatically.

Use ``` syntax to introduce the blocs of code so that we can specify the
syntax to use for color highlighting (shell, json, ...).

Convert enumerated list (1-, 2-, ...) to the proper format to get a nice
HTML enumerated list (i.e. 1., 2., ...).

Remove superfluous '\' that appeared in the output and always format file
names as code using `filename`.

BUG=None

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

Cr-Commit-Position: refs/heads/master@{#378723}
2016-03-02 10:42:50 +00:00
tfarina
e6cdc9c99a docs: fix markdown issues in ios_build_instructions.md
This patch fixes some layout issues when rendering the Markdown
file in Gitiles.

This should address the post-commit review from
b8f70688d4

BUG=None
TEST=loaded the markdown file in a Markdown viewer(I used
http://dillinger.io/), and visually inspected it.
R=sdefresne@chromium.org

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

Cr-Commit-Position: refs/heads/master@{#378522}
2016-03-01 19:37:29 +00:00
tfarina
b8f70688d4 docs: convert ios build instructions from html to markdown
This patch converts iOS Build Instructions from
https://www.chromium.org/developers/how-tos/build-instructions-ios
to Markdown and check it in docs/ directory.

The process for doing this was done partially by command line tools
and partially manually after inspection at http://dillinger.io/.

The command lines to generate the markdown file were:

$ wget
https://www.chromium.org/developers/how-tos/build-instructions-ios
$ pandoc -s -r html build-instructions-ios -o ios_build_instructions.md

BUG=None
TEST=opened ios_build_instructions.md in dillinger.io and visually
inspected it.
R=sdefresne@chromium.org

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

Cr-Commit-Position: refs/heads/master@{#378417}
2016-03-01 08:42:59 +00:00