chromium/src
0
Fork 0
Code Activity

Fix various issues with Markdown docs

Browse Source 
- Removed links to old wiki pages
- Fixed broken table in test_descriptions.md
- Fixed tables that don't have heading
- Fix codeblock in common_build_tasks.md

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

Cr-Commit-Position: refs/heads/master@{#361773}
This commit is contained in:
sbc
2015-11-25 16:50:52 -08:00
committed by Commit bot
parent b1233f42c8
commit 9f033f816b
12 changed files with 73 additions and 79 deletions

2
docs/ccache_mac.md

@@ -11,7 +11,7 @@ page is about using ccache on Mac with clang and the NinjaBuild system.
## Installation ## Installation
In order to use [ccache](http://ccache.samba.org) with In order to use [ccache](http://ccache.samba.org) with
[clang](http://code.google.com/p/chromium/wiki/Clang), you need to use the [clang](clang.md), you need to use the
current [git HEAD](http://ccache.samba.org/repo.html), since the most recent current [git HEAD](http://ccache.samba.org/repo.html), since the most recent
version (3.1.9) doesn't contain the version (3.1.9) doesn't contain the
[patch needed](https://github.com/jrosdahl/ccache/pull/4) for using [patch needed](https://github.com/jrosdahl/ccache/pull/4) for using

7
docs/chromoting_build_instructions.md

@@ -36,8 +36,7 @@ If you've already checked out a copy of the browser's codebase, you can skip
this section, although you'll still need to run `gclient runhooks` to ensure you this section, although you'll still need to run `gclient runhooks` to ensure you
build using the API keys you just generated. build using the API keys you just generated.
1. Install the build dependencies, which are listed at 1. [Install the build dependencies](linux_build_instructions_prerequisites.md).
http://code.google.com/p/chromium/wiki/LinuxBuildInstructionsPrerequisites.
1. Install the depot\_tools utilities, a process that is documented at 1. Install the depot\_tools utilities, a process that is documented at
http://dev.chromium.org/developers/how-tos/install-depot-tools. http://dev.chromium.org/developers/how-tos/install-depot-tools.
1. Download the Chromium source code by running: 1. Download the Chromium source code by running:
@@ -111,8 +110,8 @@ very early stages of development. At the time of writing, you must compile from
source because no official version is being distributed. source because no official version is being distributed.
1. Follow all the instructions under the `Getting the code` and 1. Follow all the instructions under the `Getting the code` and
`Install prerequisites` sections of: TODO: 404 `Install prerequisites` sections of:
http://code.google.com/p/chromium/wiki/AndroidBuildInstructions https://www.chromium.org/developers/how-tos/android-build-instructions
1. Move into the `src/` directory that contains your checkout of the Chromium 1. Move into the `src/` directory that contains your checkout of the Chromium
code. code.
1. Build the Android app: `$ ninja -C out/Release remoting_apk` 1. Build the Android app: `$ ninja -C out/Release remoting_apk`

16
docs/common_build_tasks.md

@@ -67,11 +67,11 @@ system GYP when generating project files. This is a summary of them:
TODO(andybons): Convert to list. TODO(andybons): Convert to list.
| GYP\_DEFINES | A set of key=value pairs separated by space that will set default values of variables used in .gyp and .gypi files | |:-------------|:--------------------------------------------------------------|
|:-------------|:-------------------------------------------------------------------------------------------------------------------| | `GYP_DEFINES` | A set of key=value pairs separated by space that will set default values of variables used in .gyp and .gypi files |
| GYP\_GENERATORS | The specific generator that creates build-system specific files | | `GYP_GENERATORS` | The specific generator that creates build-system specific files |
| GYP\_GENERATOR\_FLAGS | Flags that are passed down to the tool that generates the build-system specific files | | `GYP_GENERATOR_FLAGS` | Flags that are passed down to the tool that generates the build-system specific files |
| GYP\_GENERATOR\_OUTPUT | The directory that the top-level build output directory is relative to | | `GYP_GENERATOR_OUTPUT` | The directory that the top-level build output directory is relative to |
Note also that GYP uses CPPFLAGS, CFLAGS, and CXXFLAGS when generating ninja Note also that GYP uses CPPFLAGS, CFLAGS, and CXXFLAGS when generating ninja
files (the values at build time = ninja run time are _not_ used); see files (the values at build time = ninja run time are _not_ used); see
@@ -89,12 +89,14 @@ Next to your top-level `/src/` directory, create a file called
above environment variables. For the full list of supported keys, see above environment variables. For the full list of supported keys, see
[/src/build/gyp_helper.py](/build/gyp_helper.py). [/src/build/gyp_helper.py](/build/gyp_helper.py).
``` { ```
{
'variables': { 'variables': {
'mac_strip_release': 0, 'mac_strip_release': 0,
}, 'GYP_DEFINES': }, 'GYP_DEFINES':
'clang=1 ' 'component=shared_library ' 'dcheck_always_on=1 ' 'clang=1 ' 'component=shared_library ' 'dcheck_always_on=1 '
} ``` }
```
#### include.gyp #### include.gyp

2
docs/linux_build_instructions.md

@@ -26,7 +26,7 @@ Here's an overview of the steps you'll run:
to check out Chromium. to check out Chromium.
1. We don't provide any sort of "install" step. 1. We don't provide any sort of "install" step.
1. You may want to 1. You may want to
[use a chroot](http://code.google.com/p/chromium/wiki/UsingALinuxChroot) to [use a chroot](using_a_linux_chroot.md) to
isolate yourself from versioning or packaging conflicts (or to run the isolate yourself from versioning or packaging conflicts (or to run the
layout tests). layout tests).

4
docs/linux_chromium_arm.md

@@ -26,9 +26,9 @@ and library dependencies directly from Ubuntu:
$ ./build/install-build-deps.sh $ ./build/install-build-deps.sh
### Installing the rootfs ### Installing the sysroot
A prebuilt rootfs image is kept up-to-date on Cloud Storage. It will A prebuilt sysroot image is kept up-to-date on Cloud Storage. It will
automatically be installed by gclient runhooks installed if you have automatically be installed by gclient runhooks installed if you have
`target_arch=arm` in your `GYP_DEFINES`. `target_arch=arm` in your `GYP_DEFINES`.

3
docs/linux_debugging.md

@@ -439,8 +439,7 @@ and rebuild.
See See
https://sites.google.com/a/chromium.org/dev/developers/profiling-chromium-and-webkit https://sites.google.com/a/chromium.org/dev/developers/profiling-chromium-and-webkit
and and [Linux Profiling](linux_profiling.md).
http://code.google.com/p/chromium/wiki/LinuxProfiling
## i18n ## i18n

3
docs/linux_sandboxing.md

@@ -140,8 +140,7 @@ for 'dynamic' since dynamic transitions are a little obscure in SELinux)
Sandboxing can make developing harder, see: Sandboxing can make developing harder, see:
* [this page](https://code.google.com/p/chromium/wiki/LinuxSUIDSandboxDevelopment) * [this page](linux_suid_sandbox_development.md) for the `setuid` sandbox
for the `setuid` sandbox
* [this page](http://www.chromium.org/for-testers/bug-reporting-guidelines/hanging-tabs) * [this page](http://www.chromium.org/for-testers/bug-reporting-guidelines/hanging-tabs)
for triggering crashes for triggering crashes
* [this page for debugging tricks](linux_debugging.md) * [this page for debugging tricks](linux_debugging.md)

6
docs/shift_based_development.md

@@ -58,9 +58,7 @@ done in your separate local repositories, and you still use e.g. git
pull (which in our git svn repositories behind the scenes does a `git svn fetch` etc. pull (which in our git svn repositories behind the scenes does a `git svn fetch` etc.
Shift-based collaboration won't work well (at least not with a Shift-based collaboration won't work well (at least not with a
pipeline of branches) unless you are using an "unmanaged" git checkout pipeline of branches) unless you are using an "unmanaged" git checkout.
(search for "unmanaged" on
[this page](https://code.google.com/p/chromium/wiki/UsingNewGit)).
## Example Working Rules ## Example Working Rules
@@ -149,4 +147,4 @@ To push a local branch to shiftrepo: `git push shiftrepo localbranchname`
To push all "matching" branches (i.e. push the latest copy of To push all "matching" branches (i.e. push the latest copy of
any local branch that has previously been pushed to shiftrepo): `git push shiftrepo` any local branch that has previously been pushed to shiftrepo): `git push shiftrepo`
To delete a branch from shiftrepo, it's weird: `git push shiftrepo :branchname` To delete a branch from shiftrepo, it's weird: `git push shiftrepo :branchname`

74
docs/test_descriptions.md

@@ -1,50 +1,50 @@
See [Testing and infrastructure](https://sites.google.com/a/chromium.org/dev/developers/testing) for more information. See [Testing and infrastructure](https://sites.google.com/a/chromium.org/dev/developers/testing) for more information.
|accessibility\_unittests|| |:-----------------------|:-|
|:-----------------------|:| |accessibility\_unittests| |
|angle\_unittests || |angle\_unittests | |
|app\_list\_unittests || |app\_list\_unittests | |
|ash\_unittests || |ash\_unittests | |
|aura\_unittests || |aura\_unittests | |
|base\_i18n\_perftests || |base\_i18n\_perftests | |
|base\_perftests |Performance tests for base module.| |base\_perftests |Performance tests for base module.|
|base\_unittests |Tests the base module.| |base\_unittests |Tests the base module.|
|blink\_heap\_unittests || |blink\_heap\_unittests | |
|blink\_platform\_unittests|| |blink\_platform\_unittests| |
|breakpad\_unittests || |breakpad\_unittests | |
|[browser\_tests](https://sites.google.com/a/chromium.org/dev/developers/testing/browser-tests)|Tests the browser UI. Can not inject user input or depend on focus/activation behavior because it can be run in parallel processes and/or with a locked screen, headless etc. For tests sensitive to that, use interactive\_ui\_tests. For example, when tests need to navigate to chrome://hang (see chrome/browser/ui/webui/ntp/new\_tab\_ui\_uitest.cc)| |[browser\_tests](https://sites.google.com/a/chromium.org/dev/developers/testing/browser-tests)|Tests the browser UI. Can not inject user input or depend on focus/activation behavior because it can be run in parallel processes and/or with a locked screen, headless etc. For tests sensitive to that, use interactive\_ui\_tests. For example, when tests need to navigate to chrome://hang (see chrome/browser/ui/webui/ntp/new\_tab\_ui\_uitest.cc)|
|cacheinvalidation\_unittests|| |cacheinvalidation\_unittests| |
|chromedriver\_unittests || |chromedriver\_unittests | |
|content\_browsertests |Similar to browser\_tests, but with a minimal shell contained entirely within content/. This test, as well as the entire content module, has no dependencies on chrome/.| |content\_browsertests |Similar to browser\_tests, but with a minimal shell contained entirely within content/. This test, as well as the entire content module, has no dependencies on chrome/.|
|content\_gl\_tests || |content\_gl\_tests | |
|content\_perftests || |content\_perftests | |
|content\_unittests || |content\_unittests | |
|courgette\_unittests || |courgette\_unittests | |
|crypto\_unittests || |crypto\_unittests | |
|curvecp\_unittests || |curvecp\_unittests | |
|device\_unittests |Tests for the device (Bluetooth, HID, USB, etc.) APIs.| |device\_unittests |Tests for the device (Bluetooth, HID, USB, etc.) APIs.|
|ffmpeg\_tests || |ffmpeg\_tests | |
|ffmpeg\_unittests || |ffmpeg\_unittests | |
|gfx\_unittests || |gfx\_unittests | |
|gpu\_tests || |gpu\_tests | |
|interactive\_ui\_tests |Like browser\_tests, but these tests do things like changing window focus, so that the machine running the test can't be used while the test is running. May include browsertests (derived from InProcessBrowserTest) to run in-process in case when the test is sensitive to focus transitions or injects user input/mouse events.| |interactive\_ui\_tests |Like browser\_tests, but these tests do things like changing window focus, so that the machine running the test can't be used while the test is running. May include browsertests (derived from InProcessBrowserTest) to run in-process in case when the test is sensitive to focus transitions or injects user input/mouse events.|
|ipc\_tests |Tests the IPC subsystem for communication between browser, renderer, and plugin processes.| |ipc\_tests |Tests the IPC subsystem for communication between browser, renderer, and plugin processes.|
|jingle\_unittests || |jingle\_unittests | |
|media\_unittests || |media\_unittests | |
|memory\_test || |memory\_test | |
|net\_perftests |Performance tests for the disk cache and cookie storage.| |net\_perftests |Performance tests for the disk cache and cookie storage.|
|net\_unittests |Unit tests network stack.| |net\_unittests |Unit tests network stack.|
|[page\_cycler\_tests](https://sites.google.com/a/chromium.org/dev/developers/testing/page-cyclers)|| |[page\_cycler\_tests](https://sites.google.com/a/chromium.org/dev/developers/testing/page-cyclers)| |
|performance\_ui\_tests || |performance\_ui\_tests | |
|plugin\_tests |Tests the plugin subsystem.| |plugin\_tests |Tests the plugin subsystem.|
|ppapi\_unittests |Tests to verify Chromium recovery after hanging or crashing of renderers.| |ppapi\_unittests |Tests to verify Chromium recovery after hanging or crashing of renderers.|
|printing\_unittests || |printing\_unittests | |
|reliability\_tests || |reliability\_tests | |
|safe\_browsing\_tests || |safe\_browsing\_tests | |
|sql\_unittests || |sql\_unittests | |
|startup\_tests |Test startup performance of Chromium.| |startup\_tests |Test startup performance of Chromium.|
|sync\_integration\_tests|| |sync\_integration\_tests| |
|sync\_unit\_tests || |sync\_unit\_tests | |
|tab\_switching\_test |Test tab switching functionality.| |tab\_switching\_test |Test tab switching functionality.|
|telemetry\_unittests |Tests for the core functionality of the Telemetry performance testing framework. Not performance-sensitive.| |telemetry\_unittests |Tests for the core functionality of the Telemetry performance testing framework. Not performance-sensitive.|
|telemetry\_perf\_unittests|Smoke tests to catch errors running performance tests before they run on the chromium.perf waterfall. Not performance-sensitive.| |telemetry\_perf\_unittests|Smoke tests to catch errors running performance tests before they run on the chromium.perf waterfall. Not performance-sensitive.|
@@ -52,7 +52,7 @@ See [Testing and infrastructure](https://sites.google.com/a/chromium.org/dev/dev
|[test\_installer](https://sites.google.com/a/chromium.org/dev/developers/testing/windows-installer-tests)|Tests Chrome's installer for Windows| |[test\_installer](https://sites.google.com/a/chromium.org/dev/developers/testing/windows-installer-tests)|Tests Chrome's installer for Windows|
|ui\_base\_unittests |Unit tests for //ui/base.| |ui\_base\_unittests |Unit tests for //ui/base.|
|unit\_tests |The kitchen sink for unit tests. These tests cover several modules within Chromium.| |unit\_tests |The kitchen sink for unit tests. These tests cover several modules within Chromium.|
|url\_unittests || |url\_unittests | |
|views\_unittests || |views\_unittests | |
|wav\_ola\_test || |wav\_ola\_test | |
|webkit\_unit\_tests || |webkit\_unit\_tests | |

12
docs/useful_urls.md

@@ -5,8 +5,8 @@ This page aims to be a repository of useful links that people may find useful.
## Build Status ## Build Status
| http://build.chromium.org/p/chromium/console | Main buildbot waterfall |
|:---------------------------------------------|:------------------------| |:---------------------------------------------|:------------------------|
| http://build.chromium.org/p/chromium/console | Main buildbot waterfall |
| http://chromium-status.appspot.com/lkgr | Last Known Good Revision. Trybots pull this revision from trunk. | | http://chromium-status.appspot.com/lkgr | Last Known Good Revision. Trybots pull this revision from trunk. |
| http://chromium-status.appspot.com/revisions | List of the last 100 potential LKGRs | | http://chromium-status.appspot.com/revisions | List of the last 100 potential LKGRs |
| http://build.chromium.org/p/chromium/lkgr-status/ | Status dashboard for LKGR | | http://build.chromium.org/p/chromium/lkgr-status/ | Status dashboard for LKGR |
@@ -19,8 +19,8 @@ This page aims to be a repository of useful links that people may find useful.
## For Sheriffs ## For Sheriffs
| http://build.chromium.org/p/chromium.chromiumos/waterfall?show_events=true&reload=120&failures_only=true | List of failing bots for a waterfall (chromium.chromiumos as an example) |
|:---------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------| |:---------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------|
| http://build.chromium.org/p/chromium.chromiumos/waterfall?show_events=true&reload=120&failures_only=true | List of failing bots for a waterfall (chromium.chromiumos as an example) |
| http://build.chromium.org/p/chromium.linux/waterfall?show_events=true&reload=120&builder=Linux%20Builder%20x64&builder=Linux%20Builder%20(dbg) | Monitor one or multiple bots (Linux Builder x64 and Linux Builder (dbg) on chromium.linux as an example) | | http://build.chromium.org/p/chromium.linux/waterfall?show_events=true&reload=120&builder=Linux%20Builder%20x64&builder=Linux%20Builder%20(dbg) | Monitor one or multiple bots (Linux Builder x64 and Linux Builder (dbg) on chromium.linux as an example) |
| http://build.chromium.org/p/chromium.win/waterfall/help | Customize the waterfall view for a waterfall (using chromium.win as an example) | | http://build.chromium.org/p/chromium.win/waterfall/help | Customize the waterfall view for a waterfall (using chromium.win as an example) |
| http://chromium-sheriffing.appspot.com | Alternate waterfall view that helps with test failure triage | | http://chromium-sheriffing.appspot.com | Alternate waterfall view that helps with test failure triage |
@@ -28,14 +28,14 @@ This page aims to be a repository of useful links that people may find useful.
## Release Information ## Release Information
| https://omahaproxy.appspot.com/viewer | Current release versions of Chrome on all channels |
|:--------------------------------------|:---------------------------------------------------| |:--------------------------------------|:---------------------------------------------------|
| https://omahaproxy.appspot.com/viewer | Current release versions of Chrome on all channels |
| https://omahaproxy.appspot.com/ | Looks up the revision of a build/release version | | https://omahaproxy.appspot.com/ | Looks up the revision of a build/release version |
## Source Information ## Source Information
| http://cs.chromium.org/ | Code Search |
|:------------------------|:------------| |:------------------------|:------------|
| http://cs.chromium.org/ | Code Search |
| http://cs.chromium.org/SEARCH_TERM | Code Search for a specific SEARCH\_TERM | | http://cs.chromium.org/SEARCH_TERM | Code Search for a specific SEARCH\_TERM |
| http://src.chromium.org/viewvc/chrome/ | ViewVC History Viewer | | http://src.chromium.org/viewvc/chrome/ | ViewVC History Viewer |
| http://git.chromium.org/gitweb/?p=chromium.git;a=summary | Gitweb History Viewer | | http://git.chromium.org/gitweb/?p=chromium.git;a=summary | Gitweb History Viewer |
@@ -45,8 +45,6 @@ This page aims to be a repository of useful links that people may find useful.
## Communication ## Communication
| http://groups.google.com/a/chromium.org/group/chromium-dev/topics | Chromium Developers List |
|:------------------------------------------------------------------|:-------------------------| |:------------------------------------------------------------------|:-------------------------|
| http://groups.google.com/a/chromium.org/group/chromium-dev/topics | Chromium Developers List |
| http://groups.google.com/a/chromium.org/group/chromium-discuss/topics | Chromium Users List | | http://groups.google.com/a/chromium.org/group/chromium-discuss/topics | Chromium Users List |
| http://code.google.com/p/chromium/source/list | Wiki History (SVN-based) |
| http://code.google.com/p/chromium/wiki/UserHandleMapping | Chromium User Mapping |

20
docs/user_handle_mapping.md

@@ -45,33 +45,33 @@ For Chromium contributors that have different nicks on other domains.
| jchaffraix | jchaffraix | jchaffraix | | jchaffraix | jchaffraix | jchaffraix |
| jeremy | jeremymos | playmobil | | jeremy | jeremymos | playmobil |
| jln | julien\` | jln | | jln | julien\` | jln |
| jochen | jochen`__` | eisinger | | jochen | jochen\_\_ | eisinger |
| johnnyg | johnny_g | johnnyg | | johnnyg | johnny\_g | johnnyg |
| joi | joisig | joi | | joi | joisig | joi |
| jonross | jonrossca | jonross | | jonross | jonrossca | jonross |
| jshin | jshin | jungshik | | jshin | jshin | jungshik |
| jww | jww__ | jww | | jww | jww\_\_ | jww |
| jyasskin | jyasskin | jyasskin | | jyasskin | jyasskin | jyasskin |
| karen | kareng | kareng | | karen | kareng | kareng |
| keescook | kees | keescook | | keescook | kees | keescook |
| koz | | jameskozianski | | koz | | jameskozianski |
| kuchhal | kuchhal | rahulk | | kuchhal | kuchhal | rahulk |
| levin | dave_levin | levin | | levin | dave\_levin | levin |
| lfg | lfg_ | lfg | | lfg | lfg\_ | lfg |
| luken | luken_chromium | luken | | luken | luken_chromium | luken |
| mark | markmentovai | mmentovai | | mark | markmentovai | mmentovai |
| mattm | mattm_c, mattm_g | mattm | | mattm | mattm\_c, mattm\_g | mattm |
| mbarbella | mbarbella | mbarbella | | mbarbella | mbarbella | mbarbella |
| mmeade | mmeade | mmeade | | mmeade | mmeade | mmeade |
| mednik | mednik | mednik | | mednik | mednik | mednik |
| mgaba | mgaba | mgaba | | mgaba | mgaba | mgaba |
| mlinck | dullb0yj4ck | mlinck | | mlinck | dullb0yj4ck | mlinck |
| msw | msw_ | msw | | msw | msw\_ | msw |
| nick | nickcarter | ncarter | | nick | nickcarter | ncarter |
| oleg | | olege | | oleg | | olege |
| ortuno | gortuno | ortuno | | ortuno | gortuno | ortuno |
| pam | pamg | pamg | | pam | pamg | pamg |
| paulirish | paul_irish | paulirish | | paulirish | paul\_irish | paulirish |
| patrick | pjohnson | pjohnson | | patrick | pjohnson | pjohnson |
| peter | beverloo | beverloo | | peter | beverloo | beverloo |
| phajdan.jr | phajdan-jr | phajdan | | phajdan.jr | phajdan-jr | phajdan |
@@ -82,7 +82,7 @@ For Chromium contributors that have different nicks on other domains.
| robliao | robliao | robliao | | robliao | robliao | robliao |
| rsleevi | sleevi, rsleevi | sleevi | | rsleevi | sleevi, rsleevi | sleevi |
| sarah | | sarahgordon | | sarah | | sarahgordon |
| satish | satish`_` | satish | | satish | satish\_ | satish |
| scheglov | | scheglov | | scheglov | | scheglov |
| scottbyer | sbyer | scottbyer | | scottbyer | sbyer | scottbyer |
| shans | | shanestephens | | shans | | shanestephens |
@@ -99,7 +99,7 @@ For Chromium contributors that have different nicks on other domains.
| vadimt | vadimt | vadimt | | vadimt | vadimt | vadimt |
| viettrungluu | trungl | vtl | | viettrungluu | trungl | vtl |
| wad | redpig | drewry | | wad | redpig | drewry |
| wez | real_wez | wez | | wez | real\_wez | wez |
| wjmaclean | seumas, wjmaclean | wjmaclean, wjm, seumas | | wjmaclean | seumas, wjmaclean | wjmaclean, wjm, seumas |
| yoz | yaws | yoz | | yoz | yaws | yoz |
| zmo | zhenyao | zmo | | zmo | zhenyao | zmo |

3
docs/windows_incremental_linking.md

@@ -11,5 +11,4 @@ reason.
Note that `incremental_chrome_dll=1` will probably not work on Visual Studio Note that `incremental_chrome_dll=1` will probably not work on Visual Studio
2008 builds. It may not work on Visual Studio 2010 builds either (pamg couldn't 2008 builds. It may not work on Visual Studio 2010 builds either (pamg couldn't
get it to work as of Nov 2012, encountering numerous link errors). You may have get it to work as of Nov 2012, encountering numerous link errors). You may have
to use [ninja](http://code.google.com/p/chromium/wiki/NinjaBuild), which has to use [ninja](ninja_build.md), which has incremental linking on by default.
incremental linking on by default.