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 2016/08/29 23:36:05 UTC

[kudu-CR] [docs] added Kudu version into the doxygen footer

Alexey Serbin has uploaded a new change for review.

  http://gerrit.cloudera.org:8080/4165

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................

[docs] added Kudu version into the doxygen footer

Added information on the Kudu source version into the HTML footer
of the auto-generated doxygen docs of the Kudu C++ API.

Removed sample.cc file from the list of files to process with doxygen.

Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
---
M CMakeLists.txt
M docs/support/doxygen/client_api.doxy.in
A docs/support/doxygen/client_api.footer.in
M src/kudu/client/shared_ptr.h
4 files changed, 46 insertions(+), 7 deletions(-)


  git pull ssh://gerrit.cloudera.org:29418/kudu refs/changes/65/4165/1
-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 1
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>

[kudu-CR] [docs] added Kudu version into the doxygen footer

Posted by "Kudu Jenkins (Code Review)" <ge...@cloudera.org>.
Kudu Jenkins has posted comments on this change.

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................


Patch Set 1:

Build Started http://104.196.14.100/job/kudu-gerrit/3140/

-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 1
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-HasComments: No

[kudu-CR] [docs] added Kudu version into the doxygen footer

Posted by "Adar Dembo (Code Review)" <ge...@cloudera.org>.
Adar Dembo has submitted this change and it was merged.

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................


[docs] added Kudu version into the doxygen footer

Added information on the Kudu source version into the HTML footer
of the auto-generated doxygen docs of the Kudu C++ API.

Removed sample.cc file from the list of files to process with doxygen.

Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Reviewed-on: http://gerrit.cloudera.org:8080/4165
Tested-by: Kudu Jenkins
Reviewed-by: Adar Dembo <ad...@cloudera.com>
---
M CMakeLists.txt
M docs/support/doxygen/client_api.doxy.in
A docs/support/doxygen/client_api.footer.in
M src/kudu/client/shared_ptr.h
4 files changed, 42 insertions(+), 6 deletions(-)

Approvals:
  Adar Dembo: Looks good to me, approved
  Kudu Jenkins: Verified



-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 4
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins

[kudu-CR] [docs] added Kudu version into the doxygen footer

Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Hello Kudu Jenkins,

I'd like you to reexamine a change.  Please visit

    http://gerrit.cloudera.org:8080/4165

to look at the new patch set (#3).

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................

[docs] added Kudu version into the doxygen footer

Added information on the Kudu source version into the HTML footer
of the auto-generated doxygen docs of the Kudu C++ API.

Removed sample.cc file from the list of files to process with doxygen.

Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
---
M CMakeLists.txt
M docs/support/doxygen/client_api.doxy.in
A docs/support/doxygen/client_api.footer.in
M src/kudu/client/shared_ptr.h
4 files changed, 42 insertions(+), 6 deletions(-)


  git pull ssh://gerrit.cloudera.org:29418/kudu refs/changes/65/4165/3
-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 3
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins

[kudu-CR] [docs] added Kudu version into the doxygen footer

Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has posted comments on this change.

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................


Patch Set 1:

(1 comment)

http://gerrit.cloudera.org:8080/#/c/4165/1/CMakeLists.txt
File CMakeLists.txt:

PS1, Line 79: execute_process(COMMAND git rev-parse HEAD
            :   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
            :   OUTPUT_VARIABLE KUDU_SRC_GIT_HASH)
> I didn't know that: was assuming all builds work against git-cloned repo.  
After some consideration I think adding git hash from version_defines.h deserves a separate commit.  For now it will be just sem-version, no git hash info in the doxygen footer.


-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 1
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-HasComments: Yes

[kudu-CR] [docs] added Kudu version into the doxygen footer

Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has posted comments on this change.

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................


Patch Set 1:

(6 comments)

http://gerrit.cloudera.org:8080/#/c/4165/1/CMakeLists.txt
File CMakeLists.txt:

PS1, Line 79: execute_process(COMMAND git rev-parse HEAD
            :   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
            :   OUTPUT_VARIABLE KUDU_SRC_GIT_HASH)
> What happens if this runs outside of a git repo, or if git isn't installed?
I didn't know that: was assuming all builds work against git-cloned repo.  Will re-use the generated info in version_defines.h


http://gerrit.cloudera.org:8080/#/c/4165/1/docs/support/doxygen/client_api.doxy.in
File docs/support/doxygen/client_api.doxy.in:

PS1, Line 55: share/doc/kuduClient/samples/sample.cc
> Can we substitute this in as a list? Better yet if we can somehow set it fr
Certainly, good idea!  Not sure whether it's possible to set it via src/kudu/client/CMakeLists.txt, but as for the list from the top-level CMakeLists.txt -- for sure.  Will change.


http://gerrit.cloudera.org:8080/#/c/4165/1/docs/support/doxygen/client_api.footer.in
File docs/support/doxygen/client_api.footer.in:

PS1, Line 6: </body>
           : </html>
> Presumably these were opened in the header?
Yes, this is how doxygen wants it:

http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_html_footer


http://gerrit.cloudera.org:8080/#/c/4165/1/src/kudu/client/shared_ptr.h
File src/kudu/client/shared_ptr.h:

PS1, Line 21: /// @file shared_ptr.h
> Hmm, I don't recall seeing @file tags in the other files you doxygenized. W
The @file command/directive is needed here because this file contains only 'global' entities, so without the @file they are not included into the generated documentation.  For details, take a look at the 'Important' note:

http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdfile


PS1, Line 22: pointers
> Nit: pointer
Done


PS1, Line 39: defined(__clang__)
> You can build Kudu with gcc on macOS? Didn't know that was possible.
Ah, it seems that's from my attempts to do that.  I worked some asm issues, but I stopped with glog libraries.  I'll remove this -- thanks.


-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 1
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-HasComments: Yes

[kudu-CR] [docs] added Kudu version into the doxygen footer

Posted by "Adar Dembo (Code Review)" <ge...@cloudera.org>.
Adar Dembo has posted comments on this change.

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................


Patch Set 3: Code-Review+2

-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 3
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-HasComments: No

[kudu-CR] [docs] added Kudu version into the doxygen footer

Posted by "Adar Dembo (Code Review)" <ge...@cloudera.org>.
Adar Dembo has posted comments on this change.

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................


Patch Set 2:

(6 comments)

http://gerrit.cloudera.org:8080/#/c/4165/1/CMakeLists.txt
File CMakeLists.txt:

PS1, Line 79: execute_process(COMMAND git rev-parse HEAD
            :   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
            :   OUTPUT_VARIABLE KUDU_SRC_GIT_HASH)
What happens if this runs outside of a git repo, or if git isn't installed? Some of our builds don't work directly against git.

Also, I think it would be better if we could rely on version_defines.h (see util/CMakeLists.txt) for this information instead of generating it again.


http://gerrit.cloudera.org:8080/#/c/4165/1/docs/support/doxygen/client_api.doxy.in
File docs/support/doxygen/client_api.doxy.in:

PS1, Line 55: share/doc/kuduClient/samples/sample.cc
Can we substitute this in as a list? Better yet if we can somehow set it from within src/kudu/client/CMakeLists.txt, which is where sample.cc is placed in the installation output.


http://gerrit.cloudera.org:8080/#/c/4165/1/docs/support/doxygen/client_api.footer.in
File docs/support/doxygen/client_api.footer.in:

PS1, Line 6: </body>
           : </html>
Presumably these were opened in the header?


http://gerrit.cloudera.org:8080/#/c/4165/1/src/kudu/client/shared_ptr.h
File src/kudu/client/shared_ptr.h:

PS1, Line 21: /// @file shared_ptr.h
Hmm, I don't recall seeing @file tags in the other files you doxygenized. What is its purpose here?


PS1, Line 22: pointers
Nit: pointer


PS1, Line 39: defined(__clang__)
You can build Kudu with gcc on macOS? Didn't know that was possible.


-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 2
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-HasComments: Yes

[kudu-CR] [docs] added Kudu version into the doxygen footer

Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has uploaded a new patch set (#2).

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................

[docs] added Kudu version into the doxygen footer

Added information on the Kudu source version into the HTML footer
of the auto-generated doxygen docs of the Kudu C++ API.

Removed sample.cc file from the list of files to process with doxygen.

Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
---
M CMakeLists.txt
M docs/support/doxygen/client_api.doxy.in
A docs/support/doxygen/client_api.footer.in
M src/kudu/client/shared_ptr.h
4 files changed, 42 insertions(+), 7 deletions(-)


  git pull ssh://gerrit.cloudera.org:29418/kudu refs/changes/65/4165/2
-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 2
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins

[kudu-CR] [docs] added Kudu version into the doxygen footer

Posted by "Kudu Jenkins (Code Review)" <ge...@cloudera.org>.
Kudu Jenkins has posted comments on this change.

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................


Patch Set 3:

Build Started http://104.196.14.100/job/kudu-gerrit/3147/

-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 3
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-HasComments: No

[kudu-CR] [docs] added Kudu version into the doxygen footer

Posted by "Kudu Jenkins (Code Review)" <ge...@cloudera.org>.
Kudu Jenkins has posted comments on this change.

Change subject: [docs] added Kudu version into the doxygen footer
......................................................................


Patch Set 2:

Build Started http://104.196.14.100/job/kudu-gerrit/3141/

-- 
To view, visit http://gerrit.cloudera.org:8080/4165
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I3861aafa1e615cc991647704d9a4ce8d44ad678f
Gerrit-PatchSet: 2
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-HasComments: No