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

Unified Diff: tools/gn/README.md

Issue 2407523002: Update GN documentation. (Closed)
Patch Set: for initial review Created 4 years, 2 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 | « no previous file | tools/gn/docs/faq.md » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: tools/gn/README.md
diff --git a/tools/gn/README.md b/tools/gn/README.md
index 9d92d9c21eb5e3ea2ceaf32e9924f1a3bff495a9..ad731a6f581cce310b66205b8b4447c0ec482ddb 100644
--- a/tools/gn/README.md
+++ b/tools/gn/README.md
@@ -2,13 +2,11 @@
GN is a meta-build system that generates
[NinjaBuild](https://chromium.googlesource.com/chromium/src/+/master/docs/ninja_build.md)
-files. It's meant to be faster and simpler than GYP. It outputs only Ninja build
-files.
+files so that you can build Chromium with Ninja.
-## Why bother with GN?
+## Why did you switch from GYP?
-1. We believe GN files are more readable and more maintainable
- than GYP files.
+1. We believe GN files are more readable and more maintainable than GYP files.
2. GN is fast:
* GN is 20x faster than GYP.
* GN supports automatically re-running itself as needed by Ninja
@@ -20,54 +18,19 @@ files.
4. GN gives us tools for querying the build graph; you can ask
"what does X depend on" and "who depends on Y", for example.
-## What's the status?
+## What's the status of the GYP->GN migration?
-_as of March 2016:_
+_As of Oct 2016:_
- * Linux and Android: Complete but not quite all bots have been flipped.
- Developers should be using GN on these platforms for most work.
- * Windows and ChromeOS: Should be usable for almost all development. Some
- bots need to be flipped. cros_sdk builds don't work on ChromeOS yet.
- * Mac and iOS: Work is in progress, generally not usable for normal
- development.
-
-## When are you going to be done?
-
-_as of March 2016:_
-
-We expect most work to be finishing up between now and the end of Q2.
-
-## What does "done" mean?
-
-Ideally we're done when all of the GYP files have been deleted from
-Chromium and no one misses them.
-
-We will be "mostly" done when the following are true:
-
- * All of the bots maintained by the Chrome infra team for Chromium and
- downstream of Chromium have been switched to GN. (Upstream projects
- like Skia and V8 can choose to stay on GYP if they like).
- * Any developer configurations we care about that don't have bots also
- work (Generally speaking, we're aiming to not have any of these.
- * Configurations we care about should have bots to ensure they don't
- break). We have verified that all of the tests pass. We have
- verified that the command lines match in the above configurations as
- much as possible, and we accept any differences. We have reviewed
- any binary differences that result in the official builds and
- accepted them. The GN files are the "source of truth" for the
- build, and normal chromium developers normally do not need to touch
- GYP files to keep things working. We have replacements for the
- hybrid "msvs-ninja" and "xcode-ninja" configurations that GYP can
- currently build.
-
-The difference between "mostly done" and "done" exists to cover any
-issues we haven't yet identified :)
-
-## How can I help?
-
-We could especially use infrastructure/bot, Mac, and iOS help.
-
-Or, look at [the list of open bugs](https://code.google.com/p/chromium/issues/list?can=2&q=label:Proj-GN-Migration%20-type:Project&sort=pri&colspec=ID%20Pri%20Summary%20Type%20OS%20Owner%20Status%20Modified%20Blocking) related to the migration and see if there's anything that catches your fancy.
+ * All of the Chromium builds have been switched over.
+ * Nearly all of the GYP files have been deleted from the Chromium repos.
+ * You can no longer build with GYP as a result.
+ * There are still some GYP files in place for the "Closure Compilation"
+ builders that need to be converted over.
+ * Some related projects (e.g., V8, Skia) may still support GYP for their
+ own reasons.
+ * We're still cleaning up some odds and ends like making gclient not
+ still use GYP_DEFINES.
## I want more info on GN!
« no previous file with comments | « no previous file | tools/gn/docs/faq.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698