From commits-return-8138-archive-asf-public=cust-asf.ponee.io@kudu.apache.org Wed Nov 13 19:54:28 2019 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id AF387180621 for ; Wed, 13 Nov 2019 20:54:27 +0100 (CET) Received: (qmail 68517 invoked by uid 500); 13 Nov 2019 19:54:27 -0000 Mailing-List: contact commits-help@kudu.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@kudu.apache.org Delivered-To: mailing list commits@kudu.apache.org Received: (qmail 68508 invoked by uid 99); 13 Nov 2019 19:54:27 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 13 Nov 2019 19:54:27 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id C792F851DB; Wed, 13 Nov 2019 19:54:26 +0000 (UTC) Date: Wed, 13 Nov 2019 19:54:26 +0000 To: "commits@kudu.apache.org" Subject: [kudu] branch master updated: [docs] WARN_AS_ERROR requires doxygen >= 1.8.11 MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Message-ID: <157367486675.12204.6526444355117293973@gitbox.apache.org> From: alexey@apache.org X-Git-Host: gitbox.apache.org X-Git-Repo: kudu X-Git-Refname: refs/heads/master X-Git-Reftype: branch X-Git-Oldrev: 6406123924c3900e8edd65eebbb3d93963fd2a7b X-Git-Newrev: b293343df44c0d002bb4dd3ce6334d03e7197124 X-Git-Rev: b293343df44c0d002bb4dd3ce6334d03e7197124 X-Git-NotificationType: ref_changed_plus_diff X-Git-Multimail-Version: 1.5.dev Auto-Submitted: auto-generated This is an automated email from the ASF dual-hosted git repository. alexey pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/kudu.git The following commit(s) were added to refs/heads/master by this push: new b293343 [docs] WARN_AS_ERROR requires doxygen >= 1.8.11 b293343 is described below commit b293343df44c0d002bb4dd3ce6334d03e7197124 Author: Alexey Serbin AuthorDate: Tue Oct 30 16:20:00 2018 -0700 [docs] WARN_AS_ERROR requires doxygen >= 1.8.11 The doxygen's WARN_AS_ERROR configuration parameter was introduced with version 1.8.11 released December 30, 2015. Since that was relatively long time ago and the doxygen tool is needed only when building Kudu C++ client API documentation, I think it's OK to require a relatively fresh version of the doxygen tool. Information on the version of the pre-packaged doxygen tool available supported popular Linux distributions (except for SLES): OS version (codename) | doxygen version ----------------------------------------- RHEL/CentOS 6.6 | 1.6.1 RHEL/CentOS 6.10 | 1.6.1 RHEL/CentOS 7.5 | 1.8.5 Debian 8 (jessie) | 1.8.8 Debian 9 (stretch) | 1.8.13 Ubuntu 14.04 (trusty) | 1.8.6 Ubuntu 16.04 (xenial) | 1.8.11 Ubuntu 18.04 (bionic) | 1.8.13 This is a follow-up for 6064884950f7bb5cb5ca1c4767ac0f34e1c631c9. Change-Id: I7f2cfc0a9765ee0641f1cf0138ce92e54d18ce96 Reviewed-on: http://gerrit.cloudera.org:8080/11832 Reviewed-by: Adar Dembo Tested-by: Kudu Jenkins --- CMakeLists.txt | 7 +++++-- docs/developing.adoc | 8 ++++---- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 28ac5f2..692dbc8 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1406,10 +1406,13 @@ endif (UNIX) ############################################################ # "make doxygen" target -# Needs the doxygen system package to work. +# Requires doxygen of version >= 1.8.11 to leverage the +# WARN_AS_ERROR configuration parameter (introduced in +# version 1.8.11) for spotting various issues in the Kudu +# C++ client API documentation. ############################################################ if (UNIX) - find_package(Doxygen) + find_package(Doxygen 1.8.11) if (NOT (DOXYGEN_FOUND AND DOXYGEN_DOT_FOUND)) message(WARNING "Doxygen with Dot support (graphviz) not found: 'doxygen' target is not available") else () diff --git a/docs/developing.adoc b/docs/developing.adoc index a0e590a..98f1fd7 100644 --- a/docs/developing.adoc +++ b/docs/developing.adoc @@ -45,10 +45,10 @@ 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. +doxygen of version 1.8.11 or newer 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.