skia2/site/dev/tools/codesearch.md
Ben Wagner bb9844ef69 Add client code search to docs.
Also, history seems to be available for internal code search.

No-Try: true
Docs-Preview: https://skia.org/?cl=171003
Change-Id: I13707664b88e3d84760f11f43d2bd7c35c2a8969
Reviewed-on: https://skia-review.googlesource.com/c/171003
Commit-Queue: Ben Wagner <benjaminwagner@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
Auto-Submit: Ben Wagner <benjaminwagner@google.com>
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
2018-11-14 17:37:44 +00:00

2.5 KiB

Code Search

There are a number of ways to search the Skia codebase, each with advantages and disadvantages.

cs.skia.org redirects to Chromium code search restricted to the Skia portion of the Chromium tree. You can add a query after the slash; e.g. cs.skia.org/foo will search for "foo" within the Skia tree. Chromium code search provides cross-references.

For Googlers, there is also the option of the skia depot in internal Code Search. In addition to the main skia repo, internal Code Search indexes the buildbot, common, and skia_internal repos. However, cross-references and code analysis are not available.

The Github mirrors of the skia and skia-buildbot repos are useful for investigating history and blame, or for exploring release branches or other branches. However, the search functionality is fairly limited, cross-references are not available, and in history the original committer's username is replaced with that person's Github username.

You can also navigate through the Skia repos on googlesource.com. All commits appear here first.

Code search option Search XRef History Repos Branches Freshness
cs.skia.org regexp yes yes skia master last DEPS roll
Internal regexp no yes skia buildbot common internal master hours
Github basic no yes skia buildbot all hour
googlesource none no yes all all N/A

There is an internal tool for Googlers to make it easier to search the repos of Skia clients, e.g. Chromium, Android, and Mozilla. If you use it and have suggestions, please let dogben know.