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

Side by Side Diff: README.md

Issue 2232303002: Overhaul the README files a bit. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/tools/depot_tools
Patch Set: Use better example Created 4 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 unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 This package contains tools for working with Chromium development: 1 # depot_tools
2 2
3 chrome-update-create-task.bat 3 This package contains tools for working with Chromium development. It requires
4 Creates a scheduled task to do an automatic local chromium build every day. 4 python 2.7.
5 5
6 cpplint.py
7 A copy of our linting tool which enforces Google style. Fetched from
8 http://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py
9 6
10 gcl 7 ## Tools
11 A tool for uploading and managing code reviews on the Chromium
12 project, using the Rietveld code review tool. More info at:
13 http://code.google.com/p/rietveld/
14 8
15 gclient 9 The most important tools are:
16 A script for managing a workspace with modular dependencies that
17 are each checked out independently from different repositories.
18 More info at:
19 http://code.google.com/p/gclient/
20 10
21 It updates itself automatically when running `gclient` tool. To disable 11 - `fetch`: A `gclient` wrapper to checkout a project. Use `fetch --help` for
22 auto update, set the environment variable DEPOT_TOOLS_UPDATE=0 12 more details.
13 - `gclient`: A meta-checkout tool. Think
14 [repo](https://source.android.com/source/using-repo.html) or [git
15 submodules](https://git-scm.com/docs/git-submodule), except that it support
16 OS-specific rules, e.g. do not checkout Windows only dependencies when
17 checking out for Android. Use `gclient help` for more details and
18 [README.gclient.md](README.gclient.md).
19 - `git cl`: A code review tool to interact with Rietveld or Gerrit. Use `git cl
20 help` for more details and [README.git-cl.md](README.git-cl.md).
21 - `roll-dep`: A gclient dependency management tool to submit a _dep roll_,
22 updating a dependency to a newer revision.
23 23
24 To update package manually, run .\update_depot_tools.bat on Windows, 24 There are a lot of git utilities included.
25 or ./update_depot_tools on Linux or Mac.
26 25
27 Note: on Windows if svn, git and python are not accessible, they will be 26
28 downloaded too. 27 ## Updating
28
29 `depot_tools` updates itself automatically when running `gclient` tool. To
30 disable auto update, set the environment variable `DEPOT_TOOLS_UPDATE=0`.
31
32 To update package manually, run `update_depot_tools.bat` on Windows,
33 or `./update_depot_tools` on Linux or Mac.
34
35 On Windows only, running `gclient` will install `svn` (not for long), `git`,
36 `python`.
29 37
30 38
31 ## Contributing 39 ## Contributing
32 40
33 The "gclient" wrapper knows how to keep this repository updated to
34 the latest versions of these tools as found at:
35
36 https://chromium.googlesource.com/chromium/tools/depot_tools.git
37
38 To contribute change for review: 41 To contribute change for review:
39 42
40 git new-branch <somename> 43 git new-branch <somename>
41 git add <yourchanges> 44 # Hack
42 git commit 45 git add .
46 git commit -a -m "Fixes goat teleporting"
43 # find reviewers 47 # find reviewers
44 git cl owners 48 git cl owners
45 git log <yourfiles> 49 git log -- <yourfiles>
46 # upload
47 git cl upload -r reviewer1@chromium.org,reviewer2 --send-mail
48 # open https://codereview.chromium.org/ and send mail
49 50
50 # if change is approved, flag it to be commited 51 # Request a review.
51 git cl set_commit 52 git cl upload -r reviewer1@chromium.org,reviewer2@chromium.org --send-mail
52 # if change needs more work 53
54 # Edit change description if needed.
55 git cl desc
56
57 # If change is approved, flag it to be commited.
58 git cl set-commit
59
60 # If change needs more work.
53 git rebase-update 61 git rebase-update
54 ... 62 ...
55 git cl upload 63 git cl upload -t "Fixes goat teleporter destination to be Australia"
64
65
66 ### cpplint.py
67
68 To update cpplint.py, please submit the change upstream first at
69 https://github.com/google/styleguide/tree/gh-pages/cpplint then copy it down.
OLDNEW
« no previous file with comments | « README.git-cl ('k') | README.gclient.md » ('j') | README.gclient.md » ('J')

Powered by Google App Engine
This is Rietveld 408576698