xref: /aosp_15_r20/external/skia/site/docs/dev/tools/codesearch.md (revision c8dee2aa9b3f27cf6c858bd81872bdeb2c07ed17)
1*c8dee2aaSAndroid Build Coastguard Worker
2*c8dee2aaSAndroid Build Coastguard Worker---
3*c8dee2aaSAndroid Build Coastguard Workertitle: "Code Search"
4*c8dee2aaSAndroid Build Coastguard WorkerlinkTitle: "Code Search"
5*c8dee2aaSAndroid Build Coastguard Worker
6*c8dee2aaSAndroid Build Coastguard Worker---
7*c8dee2aaSAndroid Build Coastguard Worker
8*c8dee2aaSAndroid Build Coastguard Worker
9*c8dee2aaSAndroid Build Coastguard WorkerThere are a number of ways to search the Skia codebase, each with advantages and
10*c8dee2aaSAndroid Build Coastguard Workerdisadvantages.
11*c8dee2aaSAndroid Build Coastguard Worker
12*c8dee2aaSAndroid Build Coastguard Worker[cs.skia.org](http://cs.skia.org) redirects to
13*c8dee2aaSAndroid Build Coastguard Worker[Chromium code search](https://code.google.com/p/chromium/codesearch) restricted
14*c8dee2aaSAndroid Build Coastguard Workerto the Skia portion of the Chromium tree. You can add a query after the slash;
15*c8dee2aaSAndroid Build Coastguard Workere.g. [cs.skia.org/foo](http://cs.skia.org/foo) will search for "foo" within the
16*c8dee2aaSAndroid Build Coastguard WorkerSkia tree. Chromium code search provides cross-references.
17*c8dee2aaSAndroid Build Coastguard Worker
18*c8dee2aaSAndroid Build Coastguard WorkerFor Googlers, there is also the option of [the skia depot](http://cs/#skia/) in
19*c8dee2aaSAndroid Build Coastguard Workerinternal Code Search. In addition to the
20*c8dee2aaSAndroid Build Coastguard Workermain [skia](http://cs/#skia/skia/) repo, internal Code Search indexes the
21*c8dee2aaSAndroid Build Coastguard Worker[buildbot](http://cs/#skia/buildbot/), [common](http://cs/#skia/common/),
22*c8dee2aaSAndroid Build Coastguard Workerand [skia_internal](https://cs/#skia/skia_internal/) repos. However,
23*c8dee2aaSAndroid Build Coastguard Workercross-references and code analysis are not available.
24*c8dee2aaSAndroid Build Coastguard Worker
25*c8dee2aaSAndroid Build Coastguard WorkerThe GitHub mirrors of the [skia](https://github.com/google/skia) and
26*c8dee2aaSAndroid Build Coastguard Worker[skia-buildbot](https://github.com/google/skia-buildbot) repos are useful for
27*c8dee2aaSAndroid Build Coastguard Workerinvestigating history and blame, or for exploring release branches or other
28*c8dee2aaSAndroid Build Coastguard Workerbranches. However, the search functionality is fairly limited, cross-references
29*c8dee2aaSAndroid Build Coastguard Workerare not available, and in history the original committer's username is replaced
30*c8dee2aaSAndroid Build Coastguard Workerwith that person's GitHub username.
31*c8dee2aaSAndroid Build Coastguard Worker
32*c8dee2aaSAndroid Build Coastguard WorkerYou can also navigate through the
33*c8dee2aaSAndroid Build Coastguard Worker[Skia repos on googlesource.com](https://skia.googlesource.com/). All commits
34*c8dee2aaSAndroid Build Coastguard Workerappear here first.
35*c8dee2aaSAndroid Build Coastguard Worker
36*c8dee2aaSAndroid Build Coastguard Worker  Code search option  |Search |XRef |History |Repos                         |Branches |Freshness
37*c8dee2aaSAndroid Build Coastguard Worker  --------------------|-------|-----|--------|------------------------------|---------|---------------
38*c8dee2aaSAndroid Build Coastguard Worker  [cs.skia.org][1]    |regexp | yes |yes     |skia [buildbot][5]            |main     |last DEPS roll
39*c8dee2aaSAndroid Build Coastguard Worker  [Internal][2]       |regexp | no  |yes     |skia buildbot common internal |main     |hours
40*c8dee2aaSAndroid Build Coastguard Worker  [GitHub][3]         |basic  | no  |yes     |skia buildbot                 |all      |hour
41*c8dee2aaSAndroid Build Coastguard Worker  [googlesource][4]   |none   | no  |yes     |all                           |all      |N/A
42*c8dee2aaSAndroid Build Coastguard Worker
43*c8dee2aaSAndroid Build Coastguard Worker[1]: http://cs.skia.org/             "Chromium code search"
44*c8dee2aaSAndroid Build Coastguard Worker[2]: http://cs/#skia/                "Internal Code Search"
45*c8dee2aaSAndroid Build Coastguard Worker[3]: https://github.com/google/skia  "GitHub mirror of skia"
46*c8dee2aaSAndroid Build Coastguard Worker[4]: https://skia.googlesource.com/  "Primary Skia repos on googlesource.com"
47*c8dee2aaSAndroid Build Coastguard Worker[5]: https://cs.chromium.org/chromium/skia/buildbot/
48*c8dee2aaSAndroid Build Coastguard Worker
49*c8dee2aaSAndroid Build Coastguard WorkerClient code search
50*c8dee2aaSAndroid Build Coastguard Worker------------------
51*c8dee2aaSAndroid Build Coastguard Worker
52*c8dee2aaSAndroid Build Coastguard WorkerThere is an [internal tool for
53*c8dee2aaSAndroid Build Coastguard WorkerGooglers](https://goto.google.com/skia-client-search) to make it easier to
54*c8dee2aaSAndroid Build Coastguard Workersearch the repos of Skia clients, e.g. Chromium, Android, and Mozilla. If you
55*c8dee2aaSAndroid Build Coastguard Workeruse it and have suggestions, please let kjlubick know.
56*c8dee2aaSAndroid Build Coastguard Worker
57