Overhaul the README files a bit.

I didn't change the content much but deleted some obviously wrong stuff. Renamed
the files to .md so they will be processed by gitiles.

This change is in no way "sufficient" but that's a start.

R=tandrii@chromium.org

Review-Url: https://codereview.chromium.org/2232303002
6 files changed
tree: 189425ab0d227fb91aa9633d6cd5e6aec469bf82
  1. bootstrap/
  2. fetch_configs/
  3. git-templates/
  4. infra/
  5. man/
  6. recipe_modules/
  7. support/
  8. testing_support/
  9. tests/
  10. third_party/
  11. win_toolchain/
  12. zsh-goodies/
  13. .gitignore
  14. .style.yapf
  15. annotated_gclient.py
  16. apply_issue
  17. apply_issue.bat
  18. apply_issue.py
  19. auth.py
  20. breakpad.py
  21. buildbucket.py
  22. checkout.py
  23. chrome-update-create-task.bat
  24. chrome-update.bat
  25. chrome-update.py
  26. cit
  27. cit.bat
  28. cit.py
  29. clang-format
  30. clang-format.bat
  31. clang_format.py
  32. codereview.settings
  33. commit_queue
  34. commit_queue.bat
  35. commit_queue.py
  36. cpplint.bat
  37. cpplint.py
  38. cpplint_chromium.py
  39. create-chromium-git-src
  40. create-ntfs-junction.c
  41. create-ntfs-junction.exe
  42. dart_format.py
  43. depot-tools-auth
  44. depot-tools-auth.bat
  45. depot-tools-auth.py
  46. download_from_google_storage
  47. download_from_google_storage.bat
  48. download_from_google_storage.py
  49. drover
  50. drover.bat
  51. drover.py
  52. fetch
  53. fetch.bat
  54. fetch.py
  55. fix_encoding.py
  56. gcl
  57. gcl.bat
  58. gcl.py
  59. gclient
  60. gclient-new-workdir.py
  61. gclient.bat
  62. gclient.py
  63. gclient_completion.sh
  64. gclient_scm.py
  65. gclient_utils.py
  66. gerrit_util.py
  67. git-auto-svn
  68. git-cache
  69. git-cherry-pick-upload
  70. git-cl
  71. git-crrev-parse
  72. git-crsync
  73. git-drover
  74. git-find-releases
  75. git-footers
  76. git-freeze
  77. git-gs
  78. git-hyper-blame
  79. git-map
  80. git-map-branches
  81. git-mark-merge-base
  82. git-nav-downstream
  83. git-nav-upstream
  84. git-new-branch
  85. git-number
  86. git-rebase-update
  87. git-rename-branch
  88. git-reparent-branch
  89. git-retry
  90. git-runhooks
  91. git-squash-branch
  92. git-thaw
  93. git-upstream-diff
  94. git_auto_svn.py
  95. git_cache.py
  96. git_cherry_pick_upload.py
  97. git_cl.py
  98. git_common.py
  99. git_dates.py
  100. git_drover.py
  101. git_find_releases.py
  102. git_footers.py
  103. git_freezer.py
  104. git_hyper_blame.py
  105. git_map.py
  106. git_map_branches.py
  107. git_mark_merge_base.py
  108. git_nav_downstream.py
  109. git_new_branch.py
  110. git_number.py
  111. git_rebase_update.py
  112. git_rename_branch.py
  113. git_reparent_branch.py
  114. git_retry.py
  115. git_squash_branch.py
  116. git_upstream_diff.py
  117. gn
  118. gn.bat
  119. gn.py
  120. gsutil.py
  121. LICENSE
  122. my_activity.py
  123. my_reviews.py
  124. ninja
  125. ninja-linux32
  126. ninja-linux64
  127. ninja-mac
  128. ninja.exe
  129. OWNERS
  130. owners.py
  131. owners_finder.py
  132. patch.py
  133. PRESUBMIT.py
  134. presubmit_canned_checks.py
  135. presubmit_support.py
  136. profile.xml
  137. pylint
  138. pylint.py
  139. pylintrc
  140. python_runner.sh
  141. README.gclient.md
  142. README.git-cl.md
  143. README.md
  144. README.testing
  145. recipes.py
  146. repo
  147. rietveld.py
  148. roll-dep
  149. roll-dep-svn
  150. roll-dep-svn.bat
  151. roll-dep.bat
  152. roll_dep.py
  153. roll_dep_svn.py
  154. scm.py
  155. setup_color.py
  156. subcommand.py
  157. subprocess2.py
  158. trychange.py
  159. update_depot_tools
  160. update_depot_tools.bat
  161. upload_to_google_storage.py
  162. WATCHLISTS
  163. watchlists.py
  164. weekly
  165. wtf
README.md

depot_tools

This package contains tools for working with Chromium development. It requires python 2.7.

Tools

The most important tools are:

  • fetch: A gclient wrapper to checkout a project. Use fetch --help for more details.
  • gclient: A meta-checkout tool. Think repo or git submodules, except that it support OS-specific rules, e.g. do not checkout Windows only dependencies when checking out for Android. Use gclient help for more details and README.gclient.md.
  • git cl: A code review tool to interact with Rietveld or Gerrit. Use git cl help for more details and README.git-cl.md.
  • roll-dep: A gclient dependency management tool to submit a dep roll, updating a dependency to a newer revision.

There are a lot of git utilities included.

Updating

depot_tools updates itself automatically when running gclient tool. To disable auto update, set the environment variable DEPOT_TOOLS_UPDATE=0.

To update package manually, run update_depot_tools.bat on Windows, or ./update_depot_tools on Linux or Mac.

On Windows only, running gclient will install svn (not for long), git, python.

Contributing

To contribute change for review:

git new-branch <somename>
# Hack
git add .
git commit -a -m "Fixes goat teleporting"
# find reviewers
git cl owners
git log -- <yourfiles>

# Request a review.
git cl upload -r reviewer1@chromium.org,reviewer2@chromium.org --send-mail

# Edit change description if needed.
git cl desc

# If change is approved, flag it to be commited.
git cl set-commit

# If change needs more work.
git rebase-update
...
git cl upload -t "Fixes goat teleporter destination to be Australia"

cpplint.py

To update cpplint.py, please submit the change upstream first at https://github.com/google/styleguide/tree/gh-pages/cpplint then copy it down.