Move --envlog switch to gn gen command

Author: o-lim

tools/gn/command_gen.cc

@@ -29,6 +29,7 @@ namespace commands {
 namespace {
 
 const char kSwitchCheck[] = "check";
+const char kSwitchEnvlog[] = "envlog";
 const char kSwitchFilters[] = "filters";
 const char kSwitchIde[] = "ide";
 const char kSwitchIdeValueEclipse[] = "eclipse";
@@ -278,7 +279,7 @@ const char kGen_HelpShort[] = "gen: Generate ninja files.";
 const char kGen_Help[] =
     R"(gn gen: Generate ninja files.
 
-  gn gen [--check] [<ide options>] <out_dir>
+  gn gen [--check] [--envlog=<file_name>] [<ide options>] <out_dir>
 
   Generates ninja files from the current tree and puts them in the given output
   directory.
@@ -293,6 +294,13 @@ const char kGen_Help[] =
 
   See "gn help switches" for the common command-line switches.
 
+Options
+
+  --envlog=<file_name>
+      Writes a list of environment variables to the given file. The env log
+      will show a list of environment variables referenced in gn files as
+      well as their values.
+
 IDE options
 
   GN optionally generates files for IDE. Possibilities for <ide options>
@@ -396,13 +404,16 @@ int RunGen(const std::vector<std::string>& args) {
     return 1;
   }
 
+  const base::CommandLine* command_line =
+      base::CommandLine::ForCurrentProcess();
+  bool env_logging = command_line->HasSwitch(kSwitchEnvlog);
+
   // Deliberately leaked to avoid expensive process teardown.
   Setup* setup = new Setup();
+  setup->scheduler().set_env_logging(env_logging);
   if (!setup->DoSetup(args[0], true))
     return 1;
 
-  const base::CommandLine* command_line =
-      base::CommandLine::ForCurrentProcess();
   if (command_line->HasSwitch(kSwitchCheck))
     setup->set_check_public_headers(true);
 
@@ -435,6 +446,14 @@ int RunGen(const std::vector<std::string>& args) {
     return 1;
   }
 
+  if (env_logging) {
+    std::string file_name = command_line->GetSwitchValueASCII(kSwitchEnvlog);
+    SourceFile envlog = setup->build_settings().build_dir().ResolveRelativeFile(
+        Value(nullptr, file_name), &err);
+    base::FilePath envlog_path = setup->build_settings().GetFullPath(envlog);
+    setup->scheduler().SaveEnvLog(envlog_path);
+  }
+
   if (!WriteRuntimeDepsFilesIfNecessary(setup->builder(), &err)) {
     err.PrintToStdout();
     return 1;

tools/gn/docs/reference.md

@@ -631,7 +631,7 @@
 ### <a name="gen:"></a>**gn gen**: Generate ninja files.
 
 ```
-  gn gen [--check] [<ide options>] <out_dir>
+  gn gen [--check] [--envlog=<file_name>] [<ide options>] <out_dir>
 
   Generates ninja files from the current tree and puts them in the given output
   directory.
@@ -647,6 +647,15 @@
   See "gn help switches" for the common command-line switches.
 ```
 
+#### **Options**
+
+```
+  --envlog=<file_name>
+      Writes a list of environment variables to the given file. The env log
+      will show a list of environment variables referenced in gn files as
+      well as their values.
+```
+
 #### **IDE options**
 
 ```
@@ -7028,7 +7037,6 @@
     *   [--args: Specifies build arguments overrides.](#--args)
     *   [--color: Force colored output.](#--color)
     *   [--dotfile: Override the name of the ".gn" file.](#--dotfile)
-    *   [--envlog: Writes a list of environment variables to the given file.](#--envlog)
     *   [--fail-on-unused-args: Treat unused build args as fatal errors.](#--fail-on-unused-args)
     *   [--markdown: Write help output in the Markdown format.](#--markdown)
     *   [--nocolor: Force non-colored output.](#--nocolor)

tools/gn/setup.cc

@@ -298,7 +298,6 @@ bool Setup::DoSetup(const std::string& build_dir, bool force_create) {
 
   scheduler_.set_verbose_logging(cmdline->HasSwitch(switches::kVerbose));
   scheduler_.set_verbose_log(cmdline->GetSwitchValuePath(switches::kVerbose));
-  scheduler_.set_env_logging(cmdline->HasSwitch(switches::kEnvlog));
   if (cmdline->HasSwitch(switches::kTime) ||
       cmdline->HasSwitch(switches::kTracelog))
     EnableTracing();
@@ -399,13 +398,6 @@ bool Setup::RunPostMessageLoop() {
     PrintLongHelp(SummarizeTraces());
   if (cmdline->HasSwitch(switches::kTracelog))
     SaveTraces(cmdline->GetSwitchValuePath(switches::kTracelog));
-  if (cmdline->HasSwitch(switches::kEnvlog)) {
-    std::string file_name = cmdline->GetSwitchValueASCII(switches::kEnvlog);
-    SourceFile logfile = build_settings_.build_dir().ResolveRelativeFile(
-        Value(nullptr, file_name), &err);
-    base::FilePath logfile_path = build_settings_.GetFullPath(logfile);
-    scheduler_.SaveEnvLog(logfile_path);
-  }
 
   return true;
 }

tools/gn/switches.cc

@@ -70,20 +70,6 @@ const char kDotfile_Help[] =
   It would be nice to test the edge cases and document or fix.
 )";
 
-const char kEnvlog[] = "envlog";
-const char kEnvlog_HelpShort[] =
-    "--envlog: Writes a list of environment variables to the given file.";
-const char kEnvlog_Help[] =
-    R"(--envlog: Writes a list of environment variables to the given file.
-
-  The env log will show a list of environment variables used referenced
-  in gn files as well their values.
-
-Examples
-
-  gn gen out/Default --envlog=myenv.log
-)";
-
 const char kFailOnUnusedArgs[] = "fail-on-unused-args";
 const char kFailOnUnusedArgs_HelpShort[] =
     "--fail-on-unused-args: Treat unused build args as fatal errors.";
@@ -289,7 +275,6 @@ const SwitchInfoMap& GetSwitches() {
     INSERT_VARIABLE(Args)
     INSERT_VARIABLE(Color)
     INSERT_VARIABLE(Dotfile)
-    INSERT_VARIABLE(Envlog)
     INSERT_VARIABLE(FailOnUnusedArgs)
     INSERT_VARIABLE(Markdown)
     INSERT_VARIABLE(NoColor)

tools/gn/switches.h

@@ -40,10 +40,6 @@ extern const char kDotfile[];
 extern const char kDotfile_HelpShort[];
 extern const char kDotfile_Help[];
 
-extern const char kEnvlog[];
-extern const char kEnvlog_HelpShort[];
-extern const char kEnvlog_Help[];
-
 extern const char kFailOnUnusedArgs[];
 extern const char kFailOnUnusedArgs_HelpShort[];
 extern const char kFailOnUnusedArgs_Help[];