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 <aser...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <a...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <aser...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-HasComments: Yes

Reply via email to