Skip to content

Commit

Permalink
gn: Use the term 'out_dir' consistently when referring to the output …
Browse files Browse the repository at this point in the history
…directory.

The output directory is the same as the build directory, so let's be
consistent to not confuse new users.

BUG=441955
TEST=gn help args, gn help gen, gn help ls, gn help refs
R=scottmg@chromium.org

Review URL: https://codereview.chromium.org/895433002

Cr-Commit-Position: refs/heads/master@{#314324}
  • Loading branch information
tfarina authored and Commit bot committed Feb 3, 2015
1 parent 9b6d173 commit f575e01
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions tools/gn/command_args.cc
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ int EditArgsFile(const std::string& build_dir) {
"# Build arguments go here. Examples:\n"
"# is_component_build = true\n"
"# is_debug = false\n"
"# See \"gn args <dir_name> --list\" for available build "
"# See \"gn args <out_dir> --list\" for available build "
"arguments.\n";
#if defined(OS_WIN)
// Use Windows lineendings for this file since it will often open in
Expand Down Expand Up @@ -275,13 +275,13 @@ extern const char kArgs[] = "args";
extern const char kArgs_HelpShort[] =
"args: Display or configure arguments declared by the build.";
extern const char kArgs_Help[] =
"gn args [arg name]\n"
"gn args <out_dir> [--list] [--short] [--args]\n"
"\n"
" See also \"gn help buildargs\" for a more high-level overview of how\n"
" build arguments work.\n"
"\n"
"Usage\n"
" gn args <dir_name>\n"
" gn args <out_dir>\n"
" Open the arguments for the given build directory in an editor\n"
" (as specified by the EDITOR environment variable). If the given\n"
" build directory doesn't exist, it will be created and an empty\n"
Expand All @@ -292,9 +292,9 @@ extern const char kArgs_Help[] =
"\n"
" Note: you can edit the build args manually by editing the file\n"
" \"args.gn\" in the build directory and then running\n"
" \"gn gen <build_dir>\".\n"
" \"gn gen <out_dir>\".\n"
"\n"
" gn args <dir_name> --list[=<exact_arg>] [--short]\n"
" gn args <out_dir> --list[=<exact_arg>] [--short]\n"
" Lists all build arguments available in the current configuration,\n"
" or, if an exact_arg is specified for the list flag, just that one\n"
" build argument.\n"
Expand All @@ -303,14 +303,14 @@ extern const char kArgs_Help[] =
" comment preceeding the declaration. If --short is specified,\n"
" only the names and values will be printed.\n"
"\n"
" If the dir_name is specified, the build configuration will be\n"
" If the out_dir is specified, the build configuration will be\n"
" taken from that build directory. The reason this is needed is that\n"
" the definition of some arguments is dependent on the build\n"
" configuration, so setting some values might add, remove, or change\n"
" the default values for other arguments. Specifying your exact\n"
" configuration allows the proper arguments to be displayed.\n"
"\n"
" Instead of specifying the dir_name, you can also use the\n"
" Instead of specifying the out_dir, you can also use the\n"
" command-line flag to specify the build configuration:\n"
" --args=<exact list of args to use>\n"
"\n"
Expand All @@ -334,7 +334,7 @@ extern const char kArgs_Help[] =
int RunArgs(const std::vector<std::string>& args) {
if (args.size() != 1) {
Err(Location(), "Exactly one build dir needed.",
"Usage: \"gn args <build_dir>\"\n"
"Usage: \"gn args <out_dir>\"\n"
"Or see \"gn help args\" for more variants.").PrintToStdout();
return 1;
}
Expand Down
2 changes: 1 addition & 1 deletion tools/gn/command_gen.cc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ const char kGen_HelpShort[] =
const char kGen_Help[] =
"gn gen: Generate ninja files.\n"
"\n"
" gn gen <output_directory>\n"
" gn gen <out_dir>\n"
"\n"
" Generates ninja files from the current tree and puts them in the given\n"
" output directory.\n"
Expand Down
2 changes: 1 addition & 1 deletion tools/gn/command_ls.cc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const char kLs[] = "ls";
const char kLs_HelpShort[] =
"ls: List matching targets.";
const char kLs_Help[] =
"gn ls <build dir> [<label_pattern>] [--out] [--all-toolchains]\n"
"gn ls <out_dir> [<label_pattern>] [--out] [--all-toolchains]\n"
"\n"
" Lists all targets matching the given pattern for the given builn\n"
" directory. By default, only targets in the default toolchain will\n"
Expand Down
4 changes: 2 additions & 2 deletions tools/gn/command_refs.cc
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ const char kRefs[] = "refs";
const char kRefs_HelpShort[] =
"refs: Find stuff referencing a target or file.";
const char kRefs_Help[] =
"gn refs <build_dir> (<label_pattern>|<file>) [--files] [--tree] [--all]\n"
"gn refs <out_dir> (<label_pattern>|<file>) [--files] [--tree] [--all]\n"
" [--all-toolchains]\n"
"\n"
" Finds reverse dependencies (which targets reference something). The\n"
Expand Down Expand Up @@ -282,7 +282,7 @@ const char kRefs_Help[] =
int RunRefs(const std::vector<std::string>& args) {
if (args.size() != 2) {
Err(Location(), "You're holding it wrong.",
"Usage: \"gn refs <build_dir> (<label_pattern>|<file>)\"")
"Usage: \"gn refs <out_dir> (<label_pattern>|<file>)\"")
.PrintToStdout();
return 1;
}
Expand Down

0 comments on commit f575e01

Please sign in to comment.