Repository: kudu Updated Branches: refs/heads/master 1ca7ccfb4 -> 71f21f0ab
[doc] added link to online Kudu C++ client API Added link to the auto-generated doxygen documentaion for the Kudu C++ client API. Besides, fixed broken 'build_from_source' links. Change-Id: Ie4d77b9b154b635c4aedaced9b050942529cf65f Reviewed-on: http://gerrit.cloudera.org:8080/4684 Tested-by: Kudu Jenkins Reviewed-by: Dan Burkert <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/kudu/repo Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/71f21f0a Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/71f21f0a Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/71f21f0a Branch: refs/heads/master Commit: 71f21f0abfed0175c9708a393c7dd74a505954ec Parents: 1ca7ccf Author: Alexey Serbin <[email protected]> Authored: Tue Oct 11 10:17:29 2016 -0700 Committer: Alexey Serbin <[email protected]> Committed: Wed Oct 12 01:06:59 2016 +0000 ---------------------------------------------------------------------- docs/installation.adoc | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kudu/blob/71f21f0a/docs/installation.adoc ---------------------------------------------------------------------- diff --git a/docs/installation.adoc b/docs/installation.adoc index 7cc577c..c5d136b 100644 --- a/docs/installation.adoc +++ b/docs/installation.adoc @@ -233,6 +233,7 @@ $ sudo update-rc.d kudu-tserver defaults # Debian / Ubuntu . For additional configuration of Kudu services, see link:configuration.html[Configuring Kudu]. +[[build_from_source]] == Build From Source If installing Kudu using parcels or packages does not provide the flexibility you need, you can build Kudu from source. You can build from source on any supported operating system. @@ -632,19 +633,17 @@ see `java/README.md`. // tag::view_api[] .C++ API Documentation -The documentation for the C++ client APIs is included in the header files in -`/usr/include/kudu/` if you installed Kudu using packages or subdirectories -of `src/kudu/client/` if you built Kudu from source. If you installed Kudu using parcels, -no headers are included in your installation. and you will need to <<build_kudu,build -Kudu from source>> in order to have access to the headers and shared libraries. - -The following command is a naive approach to finding relevant header files. Use -of any APIs other than the client APIs is unsupported. - -[source,bash] ----- -$ find /usr/include/kudu -type f -name *.h ----- +You can view the link:../cpp-client-api/index.html[C++ client API documentation] +online. Alternatively, after <<build_from_source,building Kudu from source>>, +you can additionally build the `doxygen` target (e.g., run `make doxygen` +if using make) and use the locally generated API documentation by opening +`docs/doxygen/client_api/html/index.html` file in your favorite Web browser. + +NOTE: In order to build the `doxygen` target, it's necessary to have +doxygen with Dot (graphviz) support installed at your build machine. If +you installed doxygen after building Kudu from source, you will need to run +`cmake` again to pick up the doxygen location and generate appropriate +targets. .Java API Documentation You can view the link:../apidocs/index.html[Java API documentation] online. Alternatively,
