Files

justincarlson 90a1c8c75a Add a categorized document index to docs/README.md.

BUG=

Review-Url: https://codereview.chromium.org/2810383003
Cr-Commit-Position: refs/heads/master@{#464626}

2017-04-14 00:34:25 +00:00

accessibility

Spruce up "ChromeVox on Desktop Linux" docs

2017-03-02 07:11:20 +00:00

images

Ozone documentation: Import the screenshot of the caca backend.

2016-11-08 12:36:21 +00:00

ios

[ios] Fix build instruction and scripts.

2017-04-05 14:34:28 +00:00

media

Adding documentation for autoplay

2017-03-30 11:28:29 +00:00

memory-infra

docs: minor fix in memory-infra compositor doc

2017-04-03 09:45:34 +00:00

sync

[Sync] Adding missing DependsOn to *ProfileSyncServiceFactory.

2017-03-28 16:52:20 +00:00

testing

web_platform_tests.md: Fix typo in the documentation.

2017-04-12 10:50:44 +00:00

ui/views

Rename WebsiteSettings code to PageInfo.

2017-03-24 21:42:07 +00:00

accessibility.md

Added docs on accessibility tests

2017-03-02 06:58:46 +00:00

adding_to_third_party.md

docs: Change "ChromeOS" to "Chrome OS".

2017-02-22 17:57:55 +00:00

android_accessing_cpp_enums_in_java.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

android_build_instructions.md

WebView: update outdated docs for test shell

2017-03-23 21:17:08 +00:00

android_cast_build_instructions.md

Add the missing Cast build instructions.

2017-04-04 02:35:01 +00:00

android_debugging_instructions.md

Add basic debugging instructions for Android Studio.

2017-03-10 22:16:35 +00:00

android_logging.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

android_studio.md

Android: Upgrade to Android Studio 2.3

2017-04-05 13:12:54 +00:00

android_test_instructions.md

Roll Android SDK to N-MR1

2017-03-30 23:46:11 +00:00

angle_in_chromium.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

atom.md

Add content from Sites to Atom guide.

2016-12-06 02:51:01 +00:00

bitmap_pipeline.md

…

browser_view_resizer.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

callback.md

Update documentation for base::ResetAndReturn(Callback*)

2017-03-18 02:49:09 +00:00

ccache_mac.md

Gut gyp_chromium, common.gypi.

2016-09-21 22:29:06 +00:00

chrome_settings.md

Note Options deprecation in more places

2017-02-27 19:50:56 +00:00

chromium_browser_vs_google_chrome.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

chromoting_android_hacking.md

Remove obsolete unused file.

2017-01-11 17:02:44 +00:00

clang_format.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

clang_static_analyzer.md

Remove dependency on scan-build wrapper script for analysis builds.

2017-03-10 19:47:21 +00:00

clang_tidy.md

Fix typo in clang-tidy documentation

2016-09-26 21:50:41 +00:00

clang_tool_refactoring.md

Share logic for generating compile DB with run_tool.py

2017-04-06 19:26:23 +00:00

clang.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

closure_compilation.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

cocoa_tips_and_tricks.md

…

code_reviews.md

Fix typo in code review documentation.

2017-02-09 19:11:33 +00:00

common_build_tasks.md

Redirect links to faster-builds tips to newly merged Linux instructions

2016-12-08 02:12:05 +00:00

component_build.md

Add a common mistake case for header-only classes in components build doc

2017-02-17 22:41:21 +00:00

cr_user_manual.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

cygwin_dll_remapping_failure.md

…

documentation_best_practices.md

Update web-platform-tests docs

2017-02-15 15:03:16 +00:00

documentation_guidelines.md

Add Chromium documentation guidelines.

2017-02-14 03:55:39 +00:00

eclipse.md

Update classpath to make Robolectric JUnit tests work in Eclipse.

2016-10-03 15:21:24 +00:00

emacs.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

erc_irc.md

…

es6_chromium.md

Add => as an allowed feature to ES6 style guide

2016-12-22 03:32:08 +00:00

get_the_code.md

Move ios documentation from //docs to //docs/ios.

2017-03-06 22:12:02 +00:00

git_cookbook.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

git_tips.md

Fix typos in git_tips.md doc.

2017-03-31 20:20:41 +00:00

google_play_services.md

[gmscore] Add Google Play services documentation

2016-12-06 18:58:54 +00:00

graphical_debugging_aid_chromium_views.md

…

gtk_vs_views_gtk.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

how_to_extend_layout_test_framework.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

installation_at_vmware.md

…

ios_build_instructions.md

Move ios documentation from //docs to //docs/ios.

2017-03-06 22:12:02 +00:00

ios_infra.md

Move ios documentation from //docs to //docs/ios.

2017-03-06 22:12:02 +00:00

ios_voiceover.md

Move ios documentation from //docs to //docs/ios.

2017-03-06 22:12:02 +00:00

ipc_fuzzer.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

kiosk_mode.md

…

layout_tests_linux.md

Remove stray doc references to valgrind.

2017-01-17 01:39:38 +00:00

linux_build_instructions_prerequisites.md

…

linux_build_instructions.md

Use name attribute not id attribute for anchor tag in Markdown

2016-12-09 22:50:17 +00:00

linux_building_debug_gtk.md

…

linux_cast_build_instructions.md

Add the missing Cast build instructions.

2017-04-04 02:35:01 +00:00

linux_cert_management.md

…

linux_chromium_arm.md

Remove wheezy sysroot images support

2017-04-05 19:36:16 +00:00

linux_chromium_packages.md

…

linux_crash_dumping.md

…

linux_debugging_gtk.md

…

linux_debugging_ssl.md

…

linux_debugging.md

Remove stray doc references to valgrind.

2017-01-17 01:39:38 +00:00

linux_dev_build_as_default_browser.md

…

linux_development.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

linux_eclipse_dev.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

linux_graphics_pipeline.md

…

linux_gtk_theme_integration.md

Gtk3: More fixes and refactorings

2017-02-10 20:05:48 +00:00

linux_hw_video_decode.md

…

linux_minidump_to_core.md

docs: Change "ChromeOS" to "Chrome OS".

2017-02-22 17:57:55 +00:00

linux_password_storage.md

…

linux_pid_namespace_support.md

…

linux_plugins.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

linux_profiling.md

Remove stray doc references to valgrind.

2017-01-17 01:39:38 +00:00

linux_proxy_config.md

…

linux_sandbox_ipc.md

…

linux_sandboxing.md

Update web-platform-tests docs

2017-02-15 15:03:16 +00:00

linux_sublime_dev.md

Markdown formatting nit to fix a link in docs.

2017-02-22 14:10:48 +00:00

linux_suid_sandbox_development.md

…

linux_suid_sandbox.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

linux_sysroot.md

Update linux-sysroot.md

2016-12-15 23:39:34 +00:00

linux_zygote.md

docs: update zygote documentation

2017-02-07 16:00:43 +00:00

mac_build_instructions.md

Update minimum OS X version in docs for building Chrome

2017-01-25 14:47:18 +00:00

mandriva_msttcorefonts.md

…

old_chromeos_build_instructions.md

docs: Change "ChromeOS" to "Chrome OS".

2017-02-22 17:57:55 +00:00

old_chromoting_build_instructions.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

optimizing_web_uis.md

Remove references to or invocations of vulcanize.py. It's deleted.

2017-02-11 20:58:07 +00:00

optional.md

use namespace base for base::make_optional in docs

2017-03-15 02:44:26 +00:00

origin_trials_integration.md

Cleanup virtual test suites for origin trials

2017-02-23 18:16:17 +00:00

OWNERS

…

ozone_overview.md

Update Ozone documentation for Linux Desktop

2017-04-05 18:06:14 +00:00

piranha_plant.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

profiling_content_shell_on_android.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

proxy_auto_config.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

qtcreator.md

remove gdb_index in qtcreator document

2017-03-27 21:43:16 +00:00

README.md

Add a categorized document index to docs/README.md.

2017-04-14 00:34:25 +00:00

retrieving_code_analysis_warnings.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

seccomp_sandbox_crash_dumping.md

…

shift_based_development.md

…

system_hardening_features.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

tab_helpers.md

…

test_descriptions.md

…

tpm_quick_ref.md

…

updating_clang_format_binaries.md

fix a README link

2017-02-28 00:06:07 +00:00

updating_clang.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

use_find_bugs_for_android.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

useful_urls.md

Update useful_urls.md links to HTTPS.

2017-02-07 03:27:18 +00:00

user_handle_mapping.md

Add dougt/dougt/dft in user_handle_mapping.md

2017-01-21 01:33:33 +00:00

using_a_linux_chroot.md

Update web-platform-tests docs

2017-02-15 15:03:16 +00:00

using_build_runner.md

…

vanilla_msysgit_workflow.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

vscode.md

Add Visual Studio Code documentation

2017-04-12 08:29:04 +00:00

webview_policies.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

windows_build_instructions.md

Clarify that cdb is required to be installed

2017-03-08 09:04:42 +00:00

windows_split_dll.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

working_remotely_with_android.md

Fix spelling mistakes in //docs.

2016-12-02 22:16:53 +00:00

writing_clang_plugins.md

Use HTTPS links for Google domains in docs

2016-12-06 02:53:51 +00:00

README.md

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]

Style guide

Markdown documents must follow the style guide.

Previewing changes

You can preview your local changes using md_browser:

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

To review someone else's changes, apply them locally first:

# in chromium checkout
git cl patch <CL number or URL>
./tools/md_browser/md_browser.py

Document Index

Checking Out and Building

Linux Build Instructions - Linux
Mac Build Instructions - MacOS
Windows Build Instructions - Windows
Android Build Instructions - Android target (on a Linux host)
Cast Build Instructions - Cast target (on a Linux host)
Cast for Android Build Instructions - Cast for Android (on a Linux host)
iOS Build Instructions - iOS target (on a MacOS host)
Linux Chromium ARM Recipes - Recipes for building Chromium for ARM on Linux.
Common Build Tasks - Recipes for slightly more advanced build tasks
Chrome Component Build - Faster builds using more libraries
Using the BuildRunner - Scripts that extract build stops from builders and runs them locally on a slave
Cr User Manual - Manual for cr, a tool that tries to hide some of the tools used for working on Chromium behind an abstraction layer

Integrated Development Environment (IDE) Set Up Guides

Android Studio - Android Studio for Android builds
Eclipse for Android - Eclipse for Android
Eclipse for Linux - Eclipse for other platforms (This guide was written for Linux, but is probably usable on Windows/MacOS as well)
Qt Creator - Using Qt Creator as an IDE or GUI debugger
Setting up Visual Studio Code - Visual Studio Code
EMACS Notes - EMACS commands/styles/tool integrations
Atom - Atom multi-platform code editor

Git

Git Cookbook - A collection of git recipes for common tasks
Git Tips - More git tips

Clang

Clang Compiler - General information on the clang compiler, used by default on Mac and Linux
Clang Tool Refactoring - Leveraging clang tools to perform refactorings that are AST-aware
The Clang Static Analyzer - How to enable static analysis at build time
Writing Clang Plugins - Don't write a clang plugin, but if you do, read this
Updating Clang - Updating the version of Clang used to build
Using clang-format on Chromium C++ Code - Various ways to invoke clang-format on C++ code
Clang Tidy - Support for the clang-tidy tool in Chromium
Updating Clang Format Binaries - How up update the clang-format binaries that come with a checkout of Chromium

General Development

Code Reviews - Code review requirements and guidelines
Closure Compilation - The Closure JavaScript compiler
Callback<> and Bind() - All about Callbacks, Closures, and Bind().
Views Platform Styling - How views are styled to fit in different native platforms
Tab Helpers - Using WebContents/WebContentsObserver to add features to browser tabs.
Adding third_party Libraries - How to get code into third_party/
Graphical Debugging Aid for Chromium Views - Visualizing view trees during debugging
Bitmap Pipeline - How bitmaps are moved from the renderer to the screen.
base::Optional - How to use base::Optional in C++ code.
Using the Origin Trials Framework - A framework for conditionally enabling experimental APIs for testing.
SharedModelTypeProcessor in Unified Sync and Storage - Notes on the central data structure used in Chrome Sync.
Chrome Sync's Model API - Data models used for syncing information across devices using Chrome Sync.
Ozone Overview - Ozone is an abstraction layer between the window system and low level input and graphics.
Optimizing Chrome Web UIs - Notes on making webuis more performant
ES6 Support in Chromium - Implementation of ECMAScript6 features in Chromium

Testing

Running and Debugging Layout Tests
Writing Layout Tests - Layout Tests using content_shell
Layout Test Expectations and Baselines - Setting expected results of layout tests.
Layout Tests Tips - Best practices for Layout Tests
Layout Tests with Manual Fallback - Writing tests that simulate manual interventions
Extending the Layout Test Framework
Fixing Layout Test Flakiness - Diagnosing and fixing layout test flakiness due to ordering dependencies.
Running Layout Tests using content_shell - Running layout tests by hand.
Testing Browser Dialogs - Using TestBrowserDialog
Web Platform Tests - Shared tests across browser vendors
Using Breakpad with content_shell - Capture stack traces on layout test crashes without an attached debugger
Test Descriptions - Unit test targets that can be built, with associated desciptions.
IPC Fuzzer - Fuzz testing of Chromium IPC interfaces.

Misc Linux-Specific Docs

Linux Proxy Config - Network proxy sources on Linux
Debugging SSL on Linux - Tips on debugging SSL code in Linux
Linux Cert Managment - Managing X.509 Certificates in Linux
Tips for Debugging on Linux
Linux GTK Theme Integration - Having Chrome match the GTK+ theme.
Gtk vs ViewsGtk - Notes on when to use Gtk vs ViewsGtk
Browser Plugins on Linux - A collection of links to information on how browser plugins work on Linux
Linux Crash Dumping - How Breakpad uploads crash reports to Google crash servers.
Linux Minidump to Core - How to convert a Breakpad-generated minidump files to a core file readable by most debuggersx
Linux Sandbox IPC - The lower level UPC system used to route requests from the bottom of the call stack up into the browser.
Linux Dev Build as Default Browser - How to configure a Dev build of Chrome as the default browser in Linux.
Linux Chromium Packages - Packages of Chromium browser (not Chrome) provided by some Linux distributions.
seccomp Sandbox Crash Dumping - Notes on crash dumping a process running in a seccomp sandbox.
Linux Password Storage - Keychain integrations between Chromium and Linux.
Linux Sublime Development - Using Sublime as an IDE for Chromium development on Linux.
Building and Debugging GTK - Building Chromium against GTK using lower optimization levels and/or more debugging symbols.
Debugging GTK - Using the GTK Debug packages and related tools.
Chroot Notes - Setting up a chroot to work around libfreetype differences in some versions of Linux.
Linux Sandboxing - The Linux multi-process model to isolate browser components with different privileges.
Zygote Process - How the Linux Zygote process, used to spawn new processes, works.
Running Layout Tests on Linux - Linux-specific instructions for running layout tests.
Linux Sysroot Images - How builds use libraries on Linux
msttcorefonts on Mandriva - Getting fonts needed to build Chrome that are not available for Mandriva
Linux Hardware Video Decoding - Enabling hardware video decode codepaths on Linux

Misc MacOS-Specific Docs

Using CCache on Mac - Speed up builds on Mac using ccache with clang/ninja
Cocoa tips and tricks - A collection of idioms used when writing Cocoa views and controllers
MacViews Release Plan

Misc Windows-Specific Docs

Handling cygwin rebaseall failures
Hacking on ANGLE in Chromium - OpenGL ES 2.0 built on top of DirectX
Retrieveing Code Analysis Warnings - How to retrieve and summarize the warnings generated by Microsoft VC++'s /analyze compile option.
Windows Split DLLs - Splitting chrome.dll into multiple dlls to work around toolchain limitations on Windows.

Misc Android-Specific Docs

Google Play Services in Chrome for Android
Accessing C++ Enums in Java - How to use C++-defined enums in Java code
Profiling Content Shell on Android - Setting up profiling for content_shell on Android
Working Remotely with Android - Building on a remote machine for an Android device connected to your local machine
Using FindBugs for Android - Using the open source static analysis tool findbugs on the Java code.
Android Test Instructions - Running a build on an Android device or emulator.
Android Debugging - Tools and tips for how to debug Java and/or C/C++ code running on Android.
Android Logging - How Chrome's logging API works with android.util.Log on Android, and usage guidelines.
Chromoting Android Hacking - Viewing the logs and debugging the Chrome Remote Desktop Android client.

Misc iOS-Specific Docs

Continuous Build and Test Infrastructure for Chromium for iOS
Opening links in Chrome for iOS - How to have your iOS app open links in Chrome.
User Agent in Chrome for iOS - Notes on User Agent strings using Chrome for iOS.

Media

Audio Focus Handling - How multiple MediaSession audio streams interact
Autoplay of HTMLMediaElements - How HTMLMediaElements are autoplayed.
Piranha Plant - Future architecture of MediaStreams

Accessibility

Accessibility Overview - Overview of accessibility concerns and approaches in Chromium.
Accessibility Tests - Where to find accessibility-related tests in the codebase.
ChromeVox on Chrome OS - Enabling spoken feedback (ChromeVox) on Chrome OS.
ChromeVox on Desktop Linux - Enabling spoken feedback (ChromeVox) on desktop Linux.
BRLTTY in Chrome OS - Chrome OS integration with BRLTTY to support refreshable braille displays
PATTS on Chrome OS - Notes on the PATTS speech sythesis engine used on Chrome OS
VoiceOver - Using Apple's VoiceOver feature with Chromium on iOS.

Memory Infrastructure Timeline Profiling (MemoryInfra)

Misc

Useful URLs - A collection of links to various tools and dashboards
ERC IRC - Using ERC in EMACS to access IRC
Kiosk Mode - Simulating kiosk mode.
User Handle Mapping - Names of developers across Chromium/IRC/Google
Documentation Best Practices
Documentation Guidelines
Shift-Based Development - An experiment in handing off development of coordinated work between developers in different time zones.
Chromium Browser vs Google Chrome - What's the difference between Chromium Browser and Google Chrome?
Proxy Auto Config using WPAD - How WPAD servers are used to automatically set proxy settings.
Installing Chromium OS on VMWare - How to install Chromium OS on VMWare.

Probably Obsolete

Old ChromeOS build instructions
TPM Quick Reference - Trusted Platform Module notes.
System Hardening Features - A list of current and planned Chrome OS security features.
Browser View Resizer - Design doc for making browser window resizing easier on Windows.
WebView Policies
Linux Profiling - How to profile Chromium on Linux
Linux Graphics Pipeline
Linux SUID Sandbox - Sandboxing renderers using a SUID binary on Linux
Linux SUID Sandbox Development - Development on the above system.
Linux PID Namespace Support
Vanilla msysgit workflow - A workflow for using mostly vanilla git on Windows.
Old Chromoting Build Instructions
Old Options - Pre-Material Design chrome://settings notes.