Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(5)

Unified Diff: docs/Hacking.md

Issue 1292053003: Lots of documentation cleanup (Closed) Base URL: https://chromium.googlesource.com/external/gyp@md-pages
Patch Set: more nits Created 5 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « docs/GypVsCMake.md ('k') | docs/LanguageSpecification.md » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/Hacking.md
diff --git a/docs/Hacking.md b/docs/Hacking.md
index b8c13909f3f6e55b9d129185ccfe97e52b349dda..cacf8af9361643c528905cdbd58c26b7919a9f77 100644
--- a/docs/Hacking.md
+++ b/docs/Hacking.md
@@ -1,4 +1,6 @@
-# GYP Hacking
+# Hacking
+
+[TOC]
Note that the instructions below assume that you have the Chromium
[depot tools](http://dev.chromium.org/developers/how-tos/depottools)
@@ -7,14 +9,24 @@ If you don't, you do not pass go, and you cannot collect your $200.
## Getting the sources
-Best is to use git to hack on anything, you can set up a git clone of GYP
-as follows:
+Git is required to hack on anything, you can set up a git clone of GYP
+as follows (assuming depot\_tools is in your path):
```
-git clone https://chromium.googlesource.com/external/gyp.git
+mkdir foo
+cd foo
+fetch gyp
cd gyp
```
+(this will create foo/.gclient and clone gyp underneath it into `foo/gyp`.
+`foo` can be any directory name you want. Once you've done that,
+you can use the repo like anything other Git repo.
+
+(Technically you can skip fetch and just do
+`git clone https://chromium.googlesource.com/external/gyp.git`,
+but `fetch gyp` is shorter).
+
## Testing your change
GYP has a suite of tests which you can run with the provided test driver
@@ -50,15 +62,20 @@ Upload your change with:
git cl upload
```
-## Submitting
+## Try jobs
Once you're ready to submit, you can use the GYP try bots to test your change
with e.g.
```
-git try
+git cl try --use-buildbucket
```
+*Trying to use the Rietveld UI to run try jobs is currently broken*.
+
+
+## Submitting
+
Once the change has been approved (LGTMed) and passes trybots, you can submit
it with:
@@ -70,8 +87,13 @@ To be allowed to submit, you will need committer rights in the project. You
need to do the new password dance at
https://chromium.googlesource.com/new-password .
-## Migrating from an old with-svn checkout
+*There currently is no commit queue for GYP, so the commit queue boxes in
+the Rietveld UI don't work either.*
+
+## Watch the tree!
+
+Gyp's Buildbot status page can be found here:
+http://build.chromium.org/p/client.gyp/
-Remove the [svn] entry from .git/config, and the .git/svn subdirs to avoid
-having `git cl land` complain that it looks like the repo is a SVN one. It might
-be easier to just repull instead.
+On that page you can view both the try job results from builds and the
+continuous results from landed commits.
« no previous file with comments | « docs/GypVsCMake.md ('k') | docs/LanguageSpecification.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698