Files

Hans Wennborg 8ba0d0a967 [docs] Add a good example CL to wmax_tokens.md

Bug: 1049569
Change-Id: Ic5ea87bd140aa51009e59ac4616a8619ede64612
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2814638
Auto-Submit: Hans Wennborg <hans@chromium.org>
Commit-Queue: Arthur Eubanks <aeubanks@google.com>
Reviewed-by: Arthur Eubanks <aeubanks@google.com>
Cr-Commit-Position: refs/heads/master@{#870574}

2021-04-08 16:52:15 +00:00

accessibility

Add instructions to debug ChromeVox on ChromeOS.

2021-02-04 05:16:13 +00:00

autofill

Add DIR_METADATA files to //docs

2020-10-08 22:56:59 +00:00

design

Set enable_cet_shadow_stack for Windows x64

2021-01-20 06:06:39 +00:00

enterprise

Migrate chrome/browser/{chromeos => ash}/arc [1/9]

2021-03-18 00:04:08 +00:00

fuchsia

Add note to Fuchsia GPU testing doc

2021-03-24 03:32:00 +00:00

gpu

Add VaapiVideoDecoder feature flag to vaapi docs

2021-03-10 18:24:21 +00:00

images

Add documentation for debugging [v]python with VSCode

2020-10-14 23:55:39 +00:00

infra

docs: Future-proof gitiles/codesearch links in infra docs.

2021-03-19 18:13:25 +00:00

ios

[LSC] Replace base::string16 with std::u16string in //[a-e]*

2021-03-11 23:38:47 +00:00

linux

Update documentation on using rr.

2021-03-30 20:18:00 +00:00

[Doc] Update child users section in user_types.md

2020-10-29 02:50:42 +00:00

mac

Mac: update triage docs to add Mac-TriageBypass tag

2021-03-23 17:04:06 +00:00

media

docs/media/gpu: Update the document about the new encoder test

2021-02-24 07:45:41 +00:00

memory

Add DIR_METADATA files to //docs

2020-10-08 22:56:59 +00:00

memory-infra

Update heap profiler documentation.

2021-03-31 01:08:24 +00:00

patterns

Convert CallbackList::Subscription to a standalone class.

2020-11-22 01:49:02 +00:00

privacy

Add DIR_METADATA files to //docs

2020-10-08 22:56:59 +00:00

privacy_budget

[privacy_budget] Document guidance on selecting surfaces.

2020-10-27 21:55:46 +00:00

process

Link to doc about performing a merge

2021-04-06 19:00:35 +00:00

security

Metrics: same-origin documents with different COOP

2021-04-08 11:28:37 +00:00

speed

Rename CLSM91Improvements flag

2021-03-20 00:09:22 +00:00

speed_metrics

WebPerf: add JS Sampling Profiler progress and objectives

2021-01-15 14:48:21 +00:00

sync

[Sync Model/Engine split] Merge {model,engine}_impl with {model,engine}

2021-02-01 15:18:45 +00:00

testing

Fix Windows paths in web tests documentation

2021-03-19 15:08:12 +00:00

[LSC] Remove base/strings/string16.h #includes

2021-03-14 19:20:08 +00:00

updater

documentation: Add CUP documentation.

2020-07-29 21:42:06 +00:00

workflow

[docs] replace isolate server with CAS in debugging-with-swarming.md

2021-01-13 07:31:47 +00:00

accessibility.md

Adds some documentation of Desktop Reader Mode.

2020-05-07 18:32:22 +00:00

ad_tagging.md

[AdTagging] Add documentation for ad tagging

2018-12-11 17:05:39 +00:00

adding_to_third_party.md

[docs] Update the .gitignore path for third-party code

2020-09-25 02:10:34 +00:00

android_accessing_cpp_enums_in_java.md

Android: add java_cpp_features GN rule

2020-10-01 20:20:14 +00:00

android_accessing_cpp_features_in_java.md

Android: add java_cpp_features GN rule

2020-10-01 20:20:14 +00:00

android_accessing_cpp_switches_in_java.md

Android: add java_cpp_features GN rule

2020-10-01 20:20:14 +00:00

android_build_instructions.md

Android: Add comments for lint

2020-07-22 15:35:22 +00:00

android_cast_build_instructions.md

Update relative links to Linux docs

2019-12-23 19:55:37 +00:00

android_debugging_instructions.md

Add link to internal Android debugging instructions

2020-09-18 01:29:25 +00:00

android_dynamic_feature_modules.md

Remove disabling of pseudolocale translations where applicable

2021-02-15 16:08:24 +00:00

android_emulator.md

Docs: add a known issue for Android L-M emulators

2021-04-06 16:10:24 +00:00

android_logging.md

Docs: miscellaneous cleanups for android_logging

2019-02-05 02:30:50 +00:00

android_native_libraries.md

base/android: use memfd_create on R+ in ModernLinker

2021-03-30 16:41:01 +00:00

android_studio.md

Fix: generate_gradle.py for native targets

2020-08-11 00:36:26 +00:00

angle_in_chromium.md

Remove references to gyp from DEPS and docs

2018-09-24 13:52:49 +00:00

asan.md

[sanitizers] Update asan docs to remove some references to asan_symbolize.py, since it is no longer needed.

2021-03-16 18:54:34 +00:00

atom.md

Update "LayoutTests" / "layout test" in docs/*.md.

2018-11-27 05:30:56 +00:00

bitmap_pipeline.md

Per https://groups.google.com/a/chromium.org/forum/#!topic/chromium-dev/irLAQ8f8uGk

2015-08-24 21:39:36 +00:00

branch_sheriff.md

[doc] [sheriffing] Add a note about respins to the Flaky tests section

2021-03-29 23:36:38 +00:00

building_old_revisions.md

Tweak //docs/building_old_revisions to mention branch heads.

2021-01-30 01:23:06 +00:00

callback.md

Update callback documentation for references

2021-03-17 17:43:38 +00:00

ccache_mac.md

Remove references to gyp from DEPS and docs

2018-09-24 13:52:49 +00:00

chrome_os_logging.md

Update logging docs.

2019-02-18 10:10:57 +00:00

chrome_settings.md

Remove chrome://settings-frame on CrOS

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

chrome_untrusted.md

docs: clarify terminologies in chrome-untrusted:// explainer

2021-02-17 00:22:42 +00:00

chromedriver_status.md

Add GetComputedRole to ChromeDriver

2020-09-23 19:19:42 +00:00

chromeos_build_instructions.md

Remove use_sysroot=false from sample args.gn

2021-03-10 21:20:37 +00:00

chromeos_glossary.md

Add chromeos_glossary.md

2019-02-01 22:45:30 +00:00

chromium_browser_vs_google_chrome.md

Update docs for media codecs in Chromium vs Chrome.

2020-11-20 22:50:58 +00:00

chromoting_android_hacking.md

android: Remove the linker tests.

2020-03-11 17:55:34 +00:00

cipd_and_3pp.md

Rename cipd.md to cipd_and_3pp.md and add docs for 3pp flow.

2021-02-12 23:16:32 +00:00

cl_respect.md

Add "Respectful Changes" to Chromium docs.

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

clang_code_coverage_wrapper.md

[code coverage] Update code coverage component references

2019-07-30 18:33:40 +00:00

clang_format.md

Update codesearch links

2020-09-09 20:57:05 +00:00

clang_sheriffing.md

clang sheriff docs: Recommend /reproduce: over /linkrepro:

2020-11-30 09:21:03 +00:00

clang_static_analyzer.md

Remove use_clang_static_analyzer and use_vs_code_analysis.

2019-03-27 17:06:19 +00:00

clang_tidy.md

Updates for things I ran into while running clang-tidy locally.

2020-10-19 01:48:29 +00:00

clang_tool_refactoring.md

Inserting an include of the new header during the rewrite.

2020-05-06 20:47:12 +00:00

clang.md

clang docs: link related documents from clang.md

2020-12-07 14:39:13 +00:00

clangd.md

Add a note about flag to clangd doc

2020-12-02 16:55:28 +00:00

clion.md

Update docs/clion.md with more includes dirs.

2021-03-20 00:14:04 +00:00

closure_compilation.md

Make GN arg for JS type checking more visible in documentation

2020-10-20 06:33:11 +00:00

cocoa_tips_and_tricks.md

Markdown style fixes for:

2015-08-26 20:13:51 +00:00

code_review_owners.md

Add a FAQ about RubberStamper to code_review_owners.md

2021-03-08 22:22:39 +00:00

code_reviews.md

[docs/code_reviews.md] explain that Rubber Stamper doesn't provide OWNERS

2021-03-24 19:58:33 +00:00

commit_checklist.md

Fix typo in commit_checklist.md

2021-04-07 21:47:04 +00:00

component_build.md

[mojo][doc] Add info about mojom_component targets

2021-03-04 20:01:15 +00:00

configuration.md

//gpu: rename switch to --ignore-gpu-blocklist

2020-07-15 16:07:54 +00:00

contributing.md

Document our implicit rule about minimizing coding languages.

2020-10-29 18:02:50 +00:00

cr_respect.md

Add "Respectful Changes" to Chromium docs.

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

cr_user_manual.md

Fix spelling mistakes in //docs.

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

cross_platform_ui.md

Docs: Add How to Write Cross-Platform UI doc

2019-03-18 17:24:10 +00:00

cygwin_dll_remapping_failure.md

A batch of docs style fixes.

2015-08-25 16:51:40 +00:00

dbus_mojo_connection_service.md

docs: Remove tokens in D-Bus MojoConnectionService Provider doc

2021-03-09 07:37:50 +00:00

debugging_with_crash_keys.md

[doc] Whitelist -> allowlist

2021-03-18 21:30:27 +00:00

deterministic_builds.md

Update terminology in deterministic_builds.md

2020-08-17 21:28:51 +00:00

DIR_METADATA

Add DIR_METADATA files to //docs

2020-10-08 22:56:59 +00:00

disassemble_code.md

Move Linux documents to a subdir

2019-12-19 20:54:32 +00:00

documentation_best_practices.md

Update the best practices documentation

2019-04-17 02:07:30 +00:00

documentation_guidelines.md

Docs: Fixing some markdown docs issues

2019-01-10 11:05:10 +00:00

early-hints.md

EarlyHints: Add markdown file about 103 Early Hints

2020-10-16 02:46:56 +00:00

eclipse.md

Remove references to gyp from DEPS and docs

2018-09-24 13:52:49 +00:00

emacs.md

docs: Update instructions for ycmd completion in emacs.

2020-07-30 14:43:15 +00:00

erc_irc.md

[Docs]: Updates to match style guide.

2015-08-31 02:25:23 +00:00

flag_expiry.md

[Docs] Update flag_expiry.md with removal instructions

2020-09-03 15:22:54 +00:00

flag_ownership.md

//gpu: rename switch to --ignore-gpu-blocklist

2020-07-15 16:07:54 +00:00

gdbinit.md

Add a notice for gdb debugging in component builds

2020-01-23 13:44:43 +00:00

get_the_code.md

[Fuchsia] Create/Reorganize documentation for Fuchsia

2021-02-17 01:41:06 +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_chrome_branded_builds.md

Use BUILDFLAG(GOOGLE_CHROME_BRANDING) more.

2019-07-29 20:05:22 +00:00

google_play_services.md

Docs: update links for Play Services doc

2021-03-09 14:54:02 +00:00

graphical_debugging_aid_chromium_views.md

Make //tools/gdb easier to use

2019-04-10 03:49:38 +00:00

gwp_asan.md

GWP-ASan: Add a link to in-depth blog post

2019-11-16 07:45:18 +00:00

how_cc_works.md

Change "FPS meter" to "Frame Rendering Stats"

2020-06-30 10:57:08 +00:00

how_to_add_your_feature_flag.md

Update link to initialize_blink_features.md

2020-11-21 05:30:41 +00:00

how_to_extend_web_test_framework.md

blinkpy: Update "layout test" in various places to "web test"

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

idn.md

Update the IDN readme and add the lookalike warning

2020-03-31 23:19:22 +00:00

initialize_blink_features.md

Clean up web_runtime_features.h

2020-11-10 00:48:28 +00:00

inlined_stack_traces.md

Document how to deal with a stack trace that has a lot of inlining.

2018-10-17 07:54:09 +00:00

installation_at_vmware.md

[Docs] Another round of stylistic fixes.

2015-08-31 02:28:22 +00:00

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

kiosk_mode.md

[Docs] Another round of stylistic fixes.

2015-08-31 02:28:22 +00:00

lacros.md

Move //chrome/browser/{chromeos => ash}/crosapi

2021-03-08 05:34:28 +00:00

lldbinit.md

[doc] add more details how to debug with lldb

2020-04-17 07:58:34 +00:00

luci_migration_faq.md

Add buildbot end of life info

2018-11-06 05:09:02 +00:00

mac_arm64.md

mac: Update arm64 docs to say that building _on_ arm macs now works, with reservations

2021-04-06 23:55:41 +00:00

mac_build_instructions.md

Remove outdated reference to lldb_chrome.py

2021-03-30 20:45:43 +00:00

mac_lld.md

[mac/lld] update things for new lld being the default lld now, and update docs

2021-03-05 20:10:33 +00:00

mojo_and_services.md

Update "Hooking Up the Service Implementation"

2020-11-13 17:19:29 +00:00

mojo_ipc_conversion.md

[mojo][doc] Remove reference to GetRemoteInterfaces

2020-02-21 20:14:01 +00:00

native_relocations.md

Update relative links to Linux docs

2019-12-23 19:55:37 +00:00

navigation_concepts.md

Update navigation_concepts.md for document.open change.

2021-03-17 23:53:59 +00:00

navigation-request-navigation-state.gv

Move references to content/browser/frame_host/

2020-09-10 15:33:56 +00:00

navigation-request-navigation-state.png

Replace state machine diagram SVG with PNG.

2020-06-10 03:13:49 +00:00

navigation.md

Expand navigation markdown documentation.

2020-06-26 05:28:17 +00:00

network_traffic_annotations.md

Implement automatic document generation for Network Traffic Annotations

2020-08-05 17:01:37 +00:00

new_port_policy.md

avoid markdown tofu

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

no_sources_assignment_filter.md

[docs] Update documentation about sources assignment filter

2020-10-14 16:54:47 +00:00

old_chromoting_build_instructions.md

Update relative links to Linux docs

2019-12-23 19:55:37 +00:00

optimizing_web_uis.md

Update compress="gzip" related documentation to reflect latest behavior.

2020-07-13 08:30:22 +00:00

optional.md

Update codesearch links

2020-09-09 20:57:05 +00:00

origin_trials_integration.md

Allow user subset exclusion for first-party origin trial tokens

2020-11-26 17:18:43 +00:00

OWNERS

Add DIR_METADATA files to //docs

2020-10-08 22:56:59 +00:00

ozone_overview.md

ozone: Add docs for running tests with use_bundled_weston

2021-01-29 23:59:13 +00:00

parsing_test_results.md

luci+mb+testing: Remove android-kitkat-arm-rel related configs

2020-04-24 20:43:43 +00:00

pgo.md

Update the PGO documentation now that the WebRTC benchmark isn't used.

2021-02-05 22:08:28 +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

Change Android SDK path to third_party/android_sdk/public

2019-03-18 21:31:23 +00:00

profiling.md

profiling doc: fix broken link for simple chrome instructions

2021-03-22 23:05:54 +00:00

proxy_auto_config.md

Fix spelling mistakes in //docs.

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

qtcreator.md

Move Linux documents to a subdir

2019-12-19 20:54:32 +00:00

README.md

docs: Add a doc for D-Bus MojoConnectionService Provider

2021-03-01 11:02:24 +00:00

release_branch_guidance.md

Quick spelling change to release_branch_guidance.md.

2020-08-26 23:48:26 +00:00

render_document.md

Added inline code markdown at "Stages"

2021-03-17 00:49:00 +00:00

render-frame-host-lifecycle-state.gv

[content] Introduce LifecycleStateImpl::kPendingCommit

2021-03-29 16:26:13 +00:00

render-frame-host-lifecycle-state.png

[content] Introduce LifecycleStateImpl::kPendingCommit

2021-03-29 16:26:13 +00:00

seccomp_sandbox_crash_dumping.md

Update relative links to Linux docs

2019-12-23 19:55:37 +00:00

servicification.md

Update service-related documentation

2020-02-19 17:09:55 +00:00

session_history.md

Add session history markdown documentation.

2020-06-15 23:20:52 +00:00

sheriff.md

TBR has been removed; update docs

2021-02-09 20:36:22 +00:00

shutdown.md

Document shutdown steps.

2020-08-25 15:27:28 +00:00

special_case_urls.md

Add markdown documentation for special case URLs.

2020-06-26 05:14:09 +00:00

static_initializers.md

Update docs about static initializers.

2021-02-19 23:35:24 +00:00

sublime_ide.md

Update the path to blink in the sublime doc.

2019-05-02 18:32:35 +00:00

system_hardening_features.md

Use HTTPS links for Google domains in docs

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

tab_helpers.md

docs: fix markdown syntax & links in tab_helpers.md

2021-01-06 19:14:23 +00:00

threading_and_tasks_faq.md

[Browser/WebTaskEnvironment] Mass-migrate away from Test(Browser|Web)ThreadBundle

2019-08-20 22:24:04 +00:00

threading_and_tasks_testing.md

Add mention of Blink to threading_and_task_testing.md

2020-03-31 16:04:56 +00:00

threading_and_tasks.md

fix the document issue

2021-03-09 16:50:41 +00:00

toolchain_support.md

Fix typo in toolchain support docs.

2020-02-17 18:54:44 +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

Move some dirs from chrome/browser/chromeos/login/

2021-02-24 23:29:51 +00:00

translation_screenshots.md

Add readme for Translation Screenshots

2018-04-17 00:55:09 +00:00

trusted_types_on_webui.md

Added a section for the test in the Trusted Types doc

2021-01-25 17:22:12 +00:00

updating_clang_format_binaries.md

linux: Don't link clang-format against zlib

2021-03-29 15:23:03 +00:00

updating_clang.md

Clarify updating Clang docs

2020-08-25 17:15:12 +00:00

use_counter_wiki.md

Undo chrome:// URL changes in the previous commit

2021-02-05 14:57:50 +00:00

useful_urls.md

Prune the list of "Useful URLs"

2018-07-09 18:39:53 +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_data_storage.md

Adding User Data Storage documentation.

2020-01-06 14:25:31 +00:00

user_handle_mapping.md

Remove mlamouri from OWNERS, WATCHLIST, and histograms.

2021-04-06 23:55:08 +00:00

using_build_runner.md

A batch of docs style fixes.

2015-08-25 17:16:40 +00:00

vanilla_msysgit_workflow.md

Remove references to gyp from DEPS and docs

2018-09-24 13:52:49 +00:00

vscode_python.md

Fix local Python VSCode debugger instructions

2020-10-16 16:55:33 +00:00

vscode.md

[vscode] Add tips about multiple Git repositories

2021-03-15 20:29:04 +00:00

webui_explainer.md

Move webui::AddResourcePathsBulk to content::WebUIDataSource.

2021-02-16 19:59:19 +00:00

webui_in_chrome.md

[LSC] Remove UTF8ToUTF16 from Literals without Escape Sequences

2021-03-22 22:26:24 +00:00

webui_in_components.md

WebUI: Remove flattenhtml=true from webui_resources.grd JS files.

2020-11-02 21:52:09 +00:00

webview_policies.md

Updates links to policy list page

2019-09-11 12:31:58 +00:00

win_cross.md

Clarify downloading Windows SDK in/out of Google

2021-03-17 23:54:03 +00:00

win_order_files.md

Remove support for using link order files on Windows

2020-11-19 18:43:33 +00:00

windows_build_instructions.md

Add section for disabling App Execution Aliases in Windows build instructions

2021-03-08 22:53:43 +00:00

windows_native_window_occlusion_tracking.md

Add .md for native window occlusion tracking on Windows.

2020-09-21 17:17:57 +00:00

windows_pwa_integration.md

Add .md doc for Windows PWA integration.

2020-09-25 02:11:38 +00:00

windows_shortcut_and_taskbar_handling.md

Add .md for Windows Shortcut and taskbar handling

2020-10-05 20:02:22 +00:00

windows_split_dll.md

Remove is_multi_dll_chrome.

2020-04-18 03:12:46 +00:00

windows_virtual_desktop_handling.md

Add .md doc for Windows Virtual Desktop support

2020-09-11 21:50:42 +00:00

wmax_tokens.md

[docs] Add a good example CL to wmax_tokens.md

2021-04-08 16:52:15 +00:00

working_remotely_with_android.md

Change Android SDK path to third_party/android_sdk/public

2019-03-18 21:31:23 +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]

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)
Fuchsia Build Instructions - Fuchsia target (on a Linux host)
iOS Build Instructions - iOS target (on a MacOS host)
Chrome OS Build Instructions - Chrome OS
Linux Chromium ARM Recipes - Recipes for building Chromium for ARM on Linux.
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
Atom - Atom multi-platform code editor
CLion - CLion IDE, supports GUI debugging.
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)
EMACS Notes - EMACS commands/styles/tool integrations
Qt Creator - Using Qt Creator as an IDE or GUI debugger
Visual Studio Code - Visual Studio Code

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
Clang Code Coverage Wrapper - Enable Clang code coverage instrumentation for a subset of source files.
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

Contributing to Chromium - Reference workflow process for contributing to the Chromium code base.
Commit Checklist - Streamlined checklist to go through before uploading CLs on Gerrit.
Code Reviews - Code review requirements and guidelines
Respectful Code Reviews - A guide for code reviewers
Respectful Changes - A guide for code authors
Mandatory Code-Review Rollout - Upcoming policy changes related to code review and OWNERS
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
Parsing Test Results - An introduction for how to understand the results emitted by polygerrit and CI builds.
Closure Compilation - The Closure JavaScript compiler
Threading and Tasks in Chrome - How to run tasks and handle thread safety in Chrome.
Callback<> and Bind() - All about Callbacks, Closures, and Bind().
Chromium Views UI - Working with the desktop UI framework.
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.
ClientTagBasedModelTypeProcessor 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
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.
WebUI Explainer - An explanation of C++ and JavaScript infrastructural code for Chrome UIs implemented with web technologies (i.e. chrome:// URLs).
Watchlists - Use watchlists to get notified of CLs you are interested in.
Shutdown - Explains the steps of Chrome shutdown, to make it easier to determine where to add a new shutdown operation.

Testing

Running and Debugging Web Tests
On disabling tests
Writing Web Tests - Web Tests using content_shell
Web Test Expectations and Baselines - Setting expected results of web tests.
Web Tests Tips - Best practices for web tests
Web Tests with Manual Fallback - Writing tests that simulate manual interventions
Extending the Web Test Framework
Fixing Web Test Flakiness - Diagnosing and fixing web test flakiness due to ordering dependencies.
Running Web Tests using content_shell - Running web tests by hand.
Web Platform Tests - Shared tests across browser vendors
Using Crashpad 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.
Fuzz Testing - Fuzz testing in Chromium.
IPC Fuzzer - Fuzz testing of Chromium IPC interfaces.
Running Chrome tests with AddressSanitizer (asan) and LeakSanitizer (lsan) - Run Chrome tests with ASAN and LSAN builds to detect addressability issues and memory leaks.
Code Coverage - Code coverage for Chromium.
Code Coverage in Gerrit - Per-CL code coverage in Gerrit to assist code reviews.

GPU Pixel Wrangling - Instructions for GPU pixel wrangling (the GPU sheriffing rotation).
Debugging GPU related code - Hints for debugging GPU- and graphics-related code.
GPU Testing - Description of Chromium's GPU testing infrastructure.
GPU Bot Details - In-depth description of how the bots are maintained.

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.
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 Web Tests on Linux - Linux-specific instructions for running web 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
Windows Split DLLs - Splitting chrome.dll into multiple dlls to work around toolchain limitations on Windows.
Windows Native Window Occlusion Tracking
Windows PWA Integration - Integration with Progressive Web Apps on Windows
Windows Shortcut and Taskbar Handling
Windows Virtual Desktop Integration

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.
Android Java Static Analysis - Catching Java related issues at compile time with the 'lint' tool.
Java Code Coverage - Collecting code coverage data with the EMMA tool.
Android BuildConfig files - What are .build_config files and how they are used.
Android App Bundles - How to build Android app bundles for Chrome.
Dynamic Feature Modules (DFMs) - How to create dynamic feature modules.
Chrome for Android UI - Resources and best practices for developing UI

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
Working With Project Files in iOS - How to add, remove, and rename files in the iOS Chromium project.

Misc Chrome-OS-Specific Docs

Misc WebUI-Specific Docs

Creating WebUI Interfaces in components/ How to create a new WebUI component in the components/ directory.
Trusted Types on WebUI Tips for coding in WebUI with Trusted Types in mind.

Media

Audio Focus Handling - How multiple MediaSession audio streams interact
Autoplay of HTMLMediaElements - How HTMLMediaElements are autoplayed.
Piranha Plant - Future architecture of MediaStreams
Video Encode Accelerator Tests - How to use the accelerated video encoder test program.
Video Decoder Tests - Running the video decoder tests.
Video Decoder Performance Tests - Running the video decoder performance tests.

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.
Offscreen, Invisible and Size - How Chrome defines offscreen, invisible and size in the accessibility tree.
Text to Speech - Overview of text to speech in Chrome and Chrome OS.
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

Memory Overview

Memory Infrastructure Timeline Profiling (MemoryInfra)

Metrics

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
Chromium Browser vs Google Chrome - What's the difference between Chromium Browser and Google Chrome?
Google Chrome branded builds
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.
User Data Storage - Policy documentation for files in User Data.

Mojo & Services

Intro to Mojo & Services - Quick introduction to Mojo and services in Chromium, with examples
Mojo API Reference - Detailed reference documentation for all things Mojo
Service Development Guidelines - Guidelines for service development in the Chromium tree
Servicifying Chromium Features - General advice for integrating new and existing subsystems into Chromium as services
Converting Legacy IPC to Mojo - Tips and common patterns for practical IPC conversion work
Mojo “Style” Guide - Recommendations for best practices from Mojo and IPC reviewers
D-Bus Mojo Connection Service - A service in Chrome to bootstrap CrOS services' Mojo connection.

Speed

Chrome Speed - Documentation for performance measurements and regressions in Chrome.
Chrome Speed Metrics - Documentation about user experience metrics in the web and their JavaScript APIs.

Probably Obsolete

TPM Quick Reference - Trusted Platform Module notes.
System Hardening Features - A list of current and planned Chrome OS security features.
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.

README.md

Chromium docs

Creating Documentation

Preview local changes using md_browser:

Review changes online with gerrit's links to gitiles:

Document Index

Checking Out and Building

Design Docs

Integrated Development Environment (IDE) Set Up Guides

Git

Clang

General Development

Testing

GPU-related docs

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)

Metrics

Misc

Mojo & Services

Speed

Probably Obsolete