You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@kudu.apache.org by "Alexey Serbin (Code Review)" <ge...@cloudera.org> on 2018/10/30 22:49:27 UTC
[kudu-CR] [docs] site.sh: treat doxygen warnings as errors
Alexey Serbin has uploaded this change for review. ( http://gerrit.cloudera.org:8080/11831
Change subject: [docs] site.sh: treat doxygen warnings as errors
......................................................................
[docs] site.sh: treat doxygen warnings as errors
With this patch, doxygen treats warnings as errors while generating
Kudu C++ client API docs for the project Web site. By default, when
just building the 'doxygen' target without any special flags in the
development environment, doxygen does not treat warnings as errors.
The idea behind this patch is to make it easier to spot various
documentation-related issues in the Kudu C++ client API when generating
public-facing documentation.
Change-Id: I8badede45f1f54788bbb05ebcb80bfb0b61120cb
---
M CMakeLists.txt
M README.adoc
M docs/support/doxygen/client_api.doxy.in
M docs/support/scripts/make_site.sh
4 files changed, 21 insertions(+), 7 deletions(-)
git pull ssh://gerrit.cloudera.org:29418/kudu refs/changes/31/11831/1
--
To view, visit http://gerrit.cloudera.org:8080/11831
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: I8badede45f1f54788bbb05ebcb80bfb0b61120cb
Gerrit-Change-Number: 11831
Gerrit-PatchSet: 1
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
[kudu-CR] [docs] site.sh: treat doxygen warnings as errors
Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has posted comments on this change. ( http://gerrit.cloudera.org:8080/11831 )
Change subject: [docs] site.sh: treat doxygen warnings as errors
......................................................................
Patch Set 1:
(1 comment)
http://gerrit.cloudera.org:8080/#/c/11831/1//COMMIT_MSG
Commit Message:
http://gerrit.cloudera.org:8080/#/c/11831/1//COMMIT_MSG@9
PS1, Line 9: With this patch, doxygen treats warnings as errors while generating
: Kudu C++ client API docs for the project Web site.
> And I presume we're currently at 0 warnings?
Thank you for the quick review.
Yes, I cleaned that all doxygen warnings in a couple of updates recently: a30c921 and 9042eda.
--
To view, visit http://gerrit.cloudera.org:8080/11831
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: I8badede45f1f54788bbb05ebcb80bfb0b61120cb
Gerrit-Change-Number: 11831
Gerrit-PatchSet: 1
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Attila Bukor <ab...@apache.org>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Comment-Date: Tue, 30 Oct 2018 23:02:24 +0000
Gerrit-HasComments: Yes
[kudu-CR] [docs] site.sh: treat doxygen warnings as errors
Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has submitted this change and it was merged. ( http://gerrit.cloudera.org:8080/11831 )
Change subject: [docs] site.sh: treat doxygen warnings as errors
......................................................................
[docs] site.sh: treat doxygen warnings as errors
With this patch, doxygen treats warnings as errors while generating
Kudu C++ client API docs for the project Web site. By default, when
just building the 'doxygen' target without any special flags in the
development environment, doxygen does not treat warnings as errors.
The idea behind this patch is to make it easier to spot various
documentation-related issues in the Kudu C++ client API when generating
public-facing documentation.
Change-Id: I8badede45f1f54788bbb05ebcb80bfb0b61120cb
Reviewed-on: http://gerrit.cloudera.org:8080/11831
Reviewed-by: Adar Dembo <ad...@cloudera.com>
Tested-by: Alexey Serbin <as...@cloudera.com>
---
M CMakeLists.txt
M README.adoc
M docs/support/doxygen/client_api.doxy.in
M docs/support/scripts/make_site.sh
4 files changed, 21 insertions(+), 7 deletions(-)
Approvals:
Adar Dembo: Looks good to me, approved
Alexey Serbin: Verified
--
To view, visit http://gerrit.cloudera.org:8080/11831
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: merged
Gerrit-Change-Id: I8badede45f1f54788bbb05ebcb80bfb0b61120cb
Gerrit-Change-Number: 11831
Gerrit-PatchSet: 2
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Attila Bukor <ab...@apache.org>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
[kudu-CR] [docs] site.sh: treat doxygen warnings as errors
Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has removed Kudu Jenkins from this change. ( http://gerrit.cloudera.org:8080/11831 )
Change subject: [docs] site.sh: treat doxygen warnings as errors
......................................................................
Removed reviewer Kudu Jenkins with the following votes:
* Verified-1 by Kudu Jenkins (120)
--
To view, visit http://gerrit.cloudera.org:8080/11831
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: deleteReviewer
Gerrit-Change-Id: I8badede45f1f54788bbb05ebcb80bfb0b61120cb
Gerrit-Change-Number: 11831
Gerrit-PatchSet: 1
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Attila Bukor <ab...@apache.org>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
[kudu-CR] [docs] site.sh: treat doxygen warnings as errors
Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has posted comments on this change. ( http://gerrit.cloudera.org:8080/11831 )
Change subject: [docs] site.sh: treat doxygen warnings as errors
......................................................................
Patch Set 1: Verified+1
Unrelated flake in RaftConsensusParamReplicationModesITest.Test_KUDU_1735/1
--
To view, visit http://gerrit.cloudera.org:8080/11831
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: I8badede45f1f54788bbb05ebcb80bfb0b61120cb
Gerrit-Change-Number: 11831
Gerrit-PatchSet: 1
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Attila Bukor <ab...@apache.org>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Comment-Date: Tue, 30 Oct 2018 23:23:44 +0000
Gerrit-HasComments: No
[kudu-CR] [docs] site.sh: treat doxygen warnings as errors
Posted by "Adar Dembo (Code Review)" <ge...@cloudera.org>.
Adar Dembo has posted comments on this change. ( http://gerrit.cloudera.org:8080/11831 )
Change subject: [docs] site.sh: treat doxygen warnings as errors
......................................................................
Patch Set 1: Code-Review+2
(1 comment)
http://gerrit.cloudera.org:8080/#/c/11831/1//COMMIT_MSG
Commit Message:
http://gerrit.cloudera.org:8080/#/c/11831/1//COMMIT_MSG@9
PS1, Line 9: With this patch, doxygen treats warnings as errors while generating
: Kudu C++ client API docs for the project Web site.
And I presume we're currently at 0 warnings?
--
To view, visit http://gerrit.cloudera.org:8080/11831
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: I8badede45f1f54788bbb05ebcb80bfb0b61120cb
Gerrit-Change-Number: 11831
Gerrit-PatchSet: 1
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Attila Bukor <ab...@apache.org>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Comment-Date: Tue, 30 Oct 2018 22:56:39 +0000
Gerrit-HasComments: Yes