diff options
author | 2016-07-21 08:27:09 +0000 | |
---|---|---|
committer | 2016-07-21 20:35:38 +0000 | |
commit | 0d04e33e51b0999c843802148ddaab676460586a (patch) | |
tree | f48cc34eadbe53fe992e56993e9ad5f551b360ad /site | |
parent | 6b1856c0da95ccea97b13890b2617bd0635f4291 (diff) |
Clean up minor spelling / grammar in Getting Started page
Hello, I work for Google but am currently contributing this as an individual. I'm interested in learning Bazel on the side, and as I'm going through the docs, I thought I'd submit code reviews for misc. Bazel site cleanup that I came across (especially for guides that act as a first impression for new users).
Let me know if you'd prefer I submit this patch in a different way. Thanks!
Closes #1529.
--
Reviewed-on: https://github.com/bazelbuild/bazel/pull/1529
MOS_MIGRATED_REVID=128035787
Diffstat (limited to 'site')
-rw-r--r-- | site/docs/getting-started.md | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/site/docs/getting-started.md b/site/docs/getting-started.md index d76b4ab9c7..0e91dd3b13 100644 --- a/site/docs/getting-started.md +++ b/site/docs/getting-started.md @@ -28,14 +28,16 @@ $ touch WORKSPACE ## Creating a Build File -To know which target can be build in your project, Bazel inspects `BUILD` files. -They are written in a Bazel's build language which is syntactically similar to -Python. Usually they are just a sequence of declarations of rules. Each rule -specifies its inputs, outputs, and a way to compute the outputs from the inputs. -The rule probably most familiar to people how have used `Makefile`s before (as -it is the only rule available there) is -the [genrule](/docs/be/general.html#genrule), which specifies how the output -can be gerated by invoking a shell command. +To know which targets can be built in your project, Bazel inspects `BUILD` +files. They are written in Bazel's build language which is syntactically +similar to Python. Usually they are just a sequence of declarations of rules. +Each rule specifies its inputs, outputs, and a way to compute the outputs from +the inputs. + +The rule probably most familiar to people who have used `Makefile`s before (as +it is the only rule available there) is the +[genrule](/docs/be/general.html#genrule), which specifies how the output can +be generated by invoking a shell command. ``` genrule( @@ -45,9 +47,9 @@ genrule( ) ``` -The shell command may contain the familiar -[Make variables](/docs/be/make-variables.html). With the quoted `BUILD` file, -you then ask Bazel to generate the target. +The shell command may contain [Make variables](/docs/be/make-variables.html). + +Using the above `BUILD` file, you can ask Bazel to generate the target. ``` $ bazel build :hello @@ -59,13 +61,12 @@ INFO: Elapsed time: 2.255s, Critical Path: 0.07s ``` We note two things. First, targets are normally referred to by their -[label](/docs/build-ref.html#labels), which is specified by the -[name](/docs/be/general.html#genrule.name) attribute of the rule. -(Referencing them by the output file name is also possible, but not -the preferred way.) -Secondly, Bazel puts the generated -files to a separate directory (the `bazel-genfiles` directory actually -is a symbolic link) to not pollute your source tree. +[label](/docs/build- ref.html#labels), which is specified by the +[name](/docs/be/general.html#genrule.name) attribute of the rule. (Referencing +them by the output file name is also possible, but this is not the preferred +way.) Second, Bazel puts the generated files into a separate directory (the +`bazel-genfiles` directory is actually a symbolic link) so as not to pollute +your source tree. Rules may use the output of other rules as input, as in the following example. Again, the generated sources are referred to by their label. @@ -85,10 +86,10 @@ genrule( ) ``` -Finally note that, while the [genrule](/docs/be/general.html#genrule) might -seem familiar, it usually is _not_ the best rule to use. It is preferrable -to use one of the specialized [rules](/docs/be/overview.html#rules) for -various languages. +Finally, note that, while the [genrule](/docs/be/general.html#genrule) might +seem familiar, it usually is _not_ the best rule to use. It is preferrable to +use one of the specialized [rules](/docs/be/overview.html#rules) for various +languages. # Next Steps |