kudu git commit: [doc] add info about the iwyu target

[mp...@apache.org]

Repository: kudu
Updated Branches:
  refs/heads/master 22835062f -> c6592eef9


[doc] add info about the iwyu target

Added information about the cmake-generated target to run IWYU
against the updated files.

In addition, fixed the following error reported by asciidoctor:
  asciidoctor: ERROR: README.adoc: line 414: only book doctypes \
    can contain level 0 sections

Change-Id: I87da493486500cde0cd226614f8a19985d295a96
Reviewed-on: http://gerrit.cloudera.org:8080/7928
Reviewed-by: Adar Dembo <ad...@cloudera.com>
Reviewed-by: Mike Percy <mp...@apache.org>
Tested-by: Mike Percy <mp...@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/kudu/repo
Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/c6592eef
Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/c6592eef
Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/c6592eef

Branch: refs/heads/master
Commit: c6592eef990d6ba8c9b3461e12330211566a3a9d
Parents: 2283506
Author: Alexey Serbin <as...@cloudera.com>
Authored: Thu Aug 31 15:44:16 2017 -0700
Committer: Mike Percy <mp...@apache.org>
Committed: Fri Sep 1 00:32:43 2017 +0000

----------------------------------------------------------------------
 README.adoc | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kudu/blob/c6592eef/README.adoc
----------------------------------------------------------------------
diff --git a/README.adoc b/README.adoc
index a096da7..dda7ab1 100644
--- a/README.adoc
+++ b/README.adoc
@@ -247,7 +247,6 @@ Then open `cov_html/coverage.html` in your web browser.
 
 === Running lint checks
 
-
 Kudu uses cpplint.py from Google to enforce coding style guidelines. You can run the
 lint checks via cmake using the `ilint` target:
 
@@ -273,6 +272,23 @@ $ make tidy
 This will scan any changes in the latest commit in the local tree. At the time
 of writing, it will not scan any changes that are not locally committed.
 
+=== Running include-what-you-use (IWYU) checks
+
+Kudu uses the https://github.com/include-what-you-use/include-what-you-use[IWYU]
+tool to keep the set of headers in the C++ source files consistent. For more
+information on what _consistent_ means, see
+https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/WhyIWYU.md[_Why IWYU_].
+
+You can run the IWYU checks via cmake using the `iwyu` target:
+
+[source,bash]
+----
+$ make iwyu
+----
+
+This will scan any file which is dirty in your working tree, or changed since the last
+gerrit-integrated upstream change in your git log.
+
 === Building Kudu documentation
 
 Kudu's documentation is written in asciidoc and lives in the _docs_ subdirectory.
@@ -407,7 +423,7 @@ on writing code, though it may affect your ability to build from within Eclipse.
 1. https://cmake.org/pipermail/cmake-developers/2011-November/014153.html
 2. http://public.kitware.com/Bug/view.php?id=15102
 
-= Export Control Notice
+== Export Control Notice
 
 This distribution uses cryptographic software and may be subject to export controls.
 Please refer to docs/export_control.adoc for more information.