Files

George Burgess IV 1ef0493b35 [Docs] Add a note about subdirectories+per-file directives

I tripped over this, causing presubmit breakages:
https://crrev.com/c/884981. In retrospect, this is sort of obvious (and
would be if I looked at the comments in the source), but...

Bug: None
Test: Looked at the new file in gitiles
Change-Id: I5aac9a0da52b34b15d8947062811779bfeeb070f
Reviewed-on: https://chromium-review.googlesource.com/884988
Reviewed-by: Lei Zhang <thestig@chromium.org>
Commit-Queue: George Burgess <gbiv@chromium.org>
Cr-Commit-Position: refs/heads/master@{#532174}

2018-01-27 07:04:04 +00:00

accessibility

Convert ax_enums.idl to mojom.

2018-01-26 17:57:04 +00:00

design

[docs] Correct the url in gpu sync docs

2018-01-15 04:52:05 +00:00

images

Add LUCI Migration Users FAQ

2018-01-17 04:04:50 +00:00

ios

Update ios infra docs.

2017-12-21 04:41:53 +00:00

media

[Blink>Media] Moving autoplay logic to AutoplayPolicy

2017-04-20 21:24:05 +00:00

memory

Minor docs update for use of OOP HP.

2018-01-23 20:19:35 +00:00

memory-infra

[Docs] Memory benchmarks: note "show all" metrics in results.html

2018-01-19 14:54:35 +00:00

process

Add branch date guidance to documentation.

2017-10-24 17:47:02 +00:00

security

Fix spelling typo in security FAQ.

2018-01-23 19:36:38 +00:00

speed

Pinpoint - Some quick docs on starting Pinpoint Perf Try Jobs.

2018-01-12 21:59:03 +00:00

sync

[Sync] Adding missing DependsOn to *ProfileSyncServiceFactory.

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

testing

Document that go/github is useful for Googlers working on wpt

2018-01-22 15:54:29 +00:00

ui/views

Cocoa coordinates start at the bottom left; content ➞ contents to be consistent with Views code.

2017-05-22 16:24:56 +00:00

accessibility.md

Adds public-facing documentation about recent changes to offscreen.

2017-12-04 17:17:33 +00:00

adding_to_third_party.md

Further improvements to third-party docs

2018-01-16 21:02:40 +00:00

android_accessing_cpp_enums_in_java.md

Cleanup definition of ActivityState and ApplicationStatus warnings

2017-05-12 20:33:39 +00:00

android_build_instructions.md

Android: Remove mentions of envsetup.sh from docs

2017-11-23 16:58:31 +00:00

android_cast_build_instructions.md

Android: Remove mentions of envsetup.sh from docs

2017-11-23 16:58:31 +00:00

android_debugging_instructions.md

docs: Debugging Robolectric tests in Android Studio

2017-12-08 21:42:15 +00:00

android_logging.md

…

android_studio.md

Update emulator documentation

2018-01-15 12:24:36 +00:00

android_test_instructions.md

Update emulator documentation

2018-01-15 12:24:36 +00:00

angle_in_chromium.md

…

atom.md

…

bitmap_pipeline.md

…

browser_view_resizer.md

…

callback.md

Add example for move version of base::Passed.

2017-10-02 22:02:49 +00:00

ccache_mac.md

…

chrome_os_logging.md

docs: Add chrome_os_logging.md.

2017-12-20 23:27:24 +00:00

chrome_settings.md

Remove chrome://settings-frame on CrOS

2017-07-26 16:52:25 +00:00

chromedriver_status.md

[ChromeDriver] Get and Set Window Rect updates on the status page

2017-11-13 16:27:27 +00:00

chromeos_build_instructions.md

cros: Update linux-chromeos documentation

2018-01-24 22:57:34 +00:00

chromium_browser_vs_google_chrome.md

…

chromoting_android_hacking.md

Android: Remove findbugs

2017-11-09 15:38:45 +00:00

cl_respect.md

Add "Respectful Changes" to Chromium docs.

2017-07-29 00:32:58 +00:00

clang_format.md

…

clang_static_analyzer.md

Update Clang static analysis Markdown doc.

2017-07-13 02:57:21 +00:00

clang_tidy.md

Update clang-tidy docs to suggest a release build of clang

2017-11-24 00:48:48 +00:00

clang_tool_refactoring.md

Update clang tool documentation.

2017-10-24 01:23:57 +00:00

clang.md

Doc updates from reading through them.

2017-09-22 18:44:40 +00:00

closure_compilation.md

Add instructions for the Closure externs generator

2017-05-01 23:40:59 +00:00

cocoa_tips_and_tricks.md

…

code_reviews.md

[Docs] Add a note about subdirectories+per-file directives

2018-01-27 07:04:04 +00:00

component_build.md

Update component build documentation

2018-01-25 22:36:31 +00:00

cr_respect.md

Add "Respectful Changes" to Chromium docs.

2017-07-29 00:32:58 +00:00

cr_user_manual.md

…

cygwin_dll_remapping_failure.md

…

debugging_with_crash_keys.md

Move crash keys documentation from Sites into the tree as Markdown.

2018-01-05 19:43:32 +00:00

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 Eclipse classpath and documentation for running JUnit tests.

2017-05-03 09:47:28 +00:00

emacs.md

emacs.md: Drop section covering Blink's coding style.

2018-01-02 08:28:43 +00:00

erc_irc.md

…

es6_chromium.md

WebUI styleguide: Allow usage of ES6 template strings (backticks).

2017-10-25 04:08:36 +00:00

fuchsia_build_instructions.md

Fix fuch->fuchsia and add note re Debug maybe working.

2017-07-12 01:09:26 +00:00

fuchsia_sdk_updates.md

Add some notes about Zircon roller to Fuchsia SDK update docs

2017-10-31 02:41:54 +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

Update docs/git_cookbook.md to remove references to svn

2017-07-13 15:34:46 +00:00

git_tips.md

git tips: Add instructions about displaying commit date

2017-06-13 15:01:11 +00:00

google_play_services.md

…

graphical_debugging_aid_chromium_views.md

…

gtk_vs_views_gtk.md

…

how_to_add_your_feature_flag.md

A follow-up of RuntimeEnabledFeatures.json5 rename.

2017-09-15 06:45:20 +00:00

how_to_extend_layout_test_framework.md

…

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

…

jumbo.md

jumboify base

2017-10-17 20:56:49 +00:00

kiosk_mode.md

…

layout_tests_linux.md

Update docs for running layout tests on Linux

2017-12-21 15:25:00 +00:00

linux_build_instructions_prerequisites.md

…

linux_build_instructions.md

docs: Remove Mandriva-related documentation.

2018-01-23 04:32:11 +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

Use the authoritative upstream source for Breakpad, move to third_party

2017-09-25 17:24:41 +00:00

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

…

linux_eclipse_dev.md

Minor clean ups to linux_eclipse_dev.md

2017-05-05 18:06:06 +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

…

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_suid_sandbox_development.md

…

linux_suid_sandbox.md

docs: remove reference to linux_sandbox_path GYP variable

2017-05-22 14:53:27 +00:00

linux_sysroot.md

Remove the Jessie sysroot

2017-11-14 23:48:50 +00:00

linux_zygote.md

fix references to zygote_host_linux.cc

2017-05-25 14:06:05 +00:00

luci_migration_faq.md

Add LUCI Migration Users FAQ

2018-01-17 04:04:50 +00:00

mac_build_instructions.md

Update mac starter instructions for unicode filenames

2018-01-03 20:31:19 +00:00

network_traffic_annotations.md

Update mutable annotations comments.

2018-01-19 08:39:07 +00:00

new_port_policy.md

avoid markdown tofu

2017-11-20 19:55:39 +00:00

old_chromoting_build_instructions.md

…

optimizing_web_uis.md

WebUI cleanup: Rename use_vulcanize GN flag to optimize_webui

2017-09-18 19:32:12 +00:00

optional.md

Fix optional.md documentation, add example.

2017-09-13 17:43:06 +00:00

origin_trials_integration.md

A follow-up of RuntimeEnabledFeatures.json5 rename.

2017-09-15 06:45:20 +00:00

OWNERS

…

ozone_overview.md

chromeos: move starting UI service for --mus to content

2017-11-06 22:53:10 +00:00

piranha_plant.md

…

profiling_content_shell_on_android.md

Android: Remove mentions of envsetup.sh from docs

2017-11-23 16:58:31 +00:00

proxy_auto_config.md

…

qtcreator.md

docs: Add instructions for using qtcreator's issues pane

2017-09-27 01:46:39 +00:00

README.md

docs: Remove Mandriva-related documentation.

2018-01-23 04:32:11 +00:00

release_branch_guidance.md

Add branch date guidance to documentation.

2017-10-24 17:47:02 +00:00

retrieving_code_analysis_warnings.md

…

seccomp_sandbox_crash_dumping.md

…

servicification.md

[services] Update documentation on services on iOS

2017-09-04 16:10:04 +00:00

static_initializers.md

Android: Fail release trybots for new static initailizers

2017-09-06 14:50:06 +00:00

sublime_ide.md

[Sublime Text] Update instructions for SublimeClang to use a newer libclang.so

2017-09-07 11:08:50 +00:00

subtle_threading_bugs.md

Port https://sites.google.com/a/chromium.org/dev/developers/design-documents/threading/suble-threading-bugs-and-patterns-to-avoid-them to in-repo documentation. This is a straight port is almost no content editing.

2017-05-17 00:37:25 +00:00

system_hardening_features.md

…

tab_helpers.md

UpdateTitleForEntry() does work both redundant and wrong; fix.

2017-09-27 03:20:52 +00:00

task_scheduler_migration.md

Mass rename RunAllBlockingPoolTasksUntilIdle to RunAllTasksUntilIdle in content::

2017-09-27 21:30:08 +00:00

test_descriptions.md

…

threading_and_tasks.md

Remove now unused BrowserThread's BlockingPool!!!

2017-09-14 18:48:21 +00:00

tour_of_luci_ui.md

Include "builds/b<id>" build results URLs

2018-01-04 23:02:54 +00:00

tpm_quick_ref.md

…

updating_clang_format_binaries.md

fix a README link

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

updating_clang.md

Added llvm-cfi-verify to the clang package.

2017-11-20 21:44:36 +00:00

useful_urls.md

Update links in useful URLs doc

2017-07-19 20:18:20 +00:00

user_data_dir.md

Fix broken link in user_data_dir.md, one more try.

2017-07-06 01:02:49 +00:00

user_handle_mapping.md

Add username mapping for katie@chromium.org

2017-11-06 17:18:58 +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

…

vscode.md

Update YCM part in VSCode docs

2017-09-01 14:44:56 +00:00

webui_explainer.md

Convert ViewHostMsg_WebUISend so that it is sent via frame (not view).

2017-10-09 18:11:37 +00:00

webui_in_components.md

[docs] replace i18n-content examples with $i18n{}

2017-12-12 20:03:58 +00:00

webview_policies.md

…

win_cross.md

Update win_cross.md docs.

2018-01-22 19:06:42 +00:00

win_order_files.md

docs/win_order_files.md: Add step to link using the new order files

2017-11-29 23:30:01 +00:00

windows_build_instructions.md

Add win_compiler_timing switch

2017-10-25 18:28:57 +00:00

windows_split_dll.md

…

working_remotely_with_android.md

Android: Remove mentions of envsetup.sh from docs

2017-11-23 16:58:31 +00:00

writing_clang_plugins.md

…

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]

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.

Review changes online with gerrit's links to gitiles:

Upload a patch to gerrit, or receive a review request. e.g. https://chromium-review.googlesource.com/c/572236
View a specific .md file. e.g. https://chromium-review.googlesource.com/c/572236/2/docs/README.md
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

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

Design Docs

See design/README.md

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
Respectful Code Reviews - A guide for code reviewers
Respectful Changes - A guide for code authors
LUCI Migration FAQ - FAQ on Buildbot-to-LUCI builder migration for Chromium
Tour of Continuous Integration UI - A tour of our the user interface for LUCI, our continuous integration system
Closure Compilation - The Closure JavaScript compiler
Threading and Tasks in Chrome - How to run tasks and handle thread safety in Chrome.
Subtle Threading Bugs and Patterns to Avoid Them - Threading pitfalls to avoid.
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
Adding a new feature flag in chrome://flags - Quick guide to add a new feature flag to experiment your feature.
Guidelines for considering branch dates in project planning - What to do (and not to do) around branch dates when scheduling your project work.

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 UI - Using TestBrowserUi
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
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
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.
Running iOS test suites locally

Misc Chrome-OS-Specific Docs

Chrome Logging on Chrome OS

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.
User Data Directory - How the user data and cache directories are determined on all platforms.

Probably Obsolete

Old Chrome OS 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.