You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@kudu.apache.org by "Grant Henke (Code Review)" <ge...@cloudera.org> on 2019/07/10 17:21:23 UTC

[kudu-CR] [docs] Update the site build to use the release directory

Grant Henke has uploaded this change for review. ( http://gerrit.cloudera.org:8080/13835


Change subject: [docs] Update the site build to use the release directory
......................................................................

[docs] Update the site build to use the release directory

Updates the make_site.sh script and make_docs.sh script
to generate docs in the versioned release directory. This
matches the new symbolic linking style we have been
using for the docs and avoids the need to manually copy
the docs durring release.

An additional flag to skip updating the symbolic links (`—no-link`) was added.

Additionally included a Doxygen fix for `SetDiffScan`.
It looks like Doxygen can’t use `@copydoc` when
the doc being copied is in a `@cond PRIVATE_API`.

Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
---
M docs/support/scripts/make_docs.sh
M docs/support/scripts/make_site.sh
M src/kudu/client/client.h
3 files changed, 71 insertions(+), 11 deletions(-)



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

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Gerrit-Change-Number: 13835
Gerrit-PatchSet: 1
Gerrit-Owner: Grant Henke <gr...@apache.org>

[kudu-CR] [docs] Update the site build to use the release directory

Posted by "Andrew Wong (Code Review)" <ge...@cloudera.org>.
Andrew Wong has posted comments on this change. ( http://gerrit.cloudera.org:8080/13835 )

Change subject: [docs] Update the site build to use the release directory
......................................................................


Patch Set 2: Code-Review+1

(1 comment)

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

PS1: 
> Doxygen was failing on this because it couldn't generate docs for SetDiffSc
I see. Yeah, I'd prefer breaking it out, as trivial as it is. Kind of surprising to find it here, even if it's noted in the body of the commit message.



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

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Gerrit-Change-Number: 13835
Gerrit-PatchSet: 2
Gerrit-Owner: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Comment-Date: Wed, 10 Jul 2019 19:41:22 +0000
Gerrit-HasComments: Yes

[kudu-CR] [docs] Update the site build to use the release directory

Posted by "Grant Henke (Code Review)" <ge...@cloudera.org>.
Hello Kudu Jenkins, Andrew Wong, 

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

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

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

Change subject: [docs] Update the site build to use the release directory
......................................................................

[docs] Update the site build to use the release directory

Updates the make_site.sh script and make_docs.sh script
to generate docs in the versioned release directory. This
matches the new symbolic linking style we have been
using for the docs and avoids the need to manually copy
the docs during release.

An additional flag to skip updating the symbolic links (`—no-link`) was added.

Additionally included a Doxygen fix for `SetDiffScan`.
It looks like Doxygen can’t use `@copydoc` when
the doc being copied is in a `@cond PRIVATE_API`.

Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
---
M docs/support/scripts/make_docs.sh
M docs/support/scripts/make_site.sh
M src/kudu/client/client.h
3 files changed, 72 insertions(+), 12 deletions(-)


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

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Gerrit-Change-Number: 13835
Gerrit-PatchSet: 2
Gerrit-Owner: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins (120)

[kudu-CR] [docs] Update the site build to use the release directory

Posted by "Andrew Wong (Code Review)" <ge...@cloudera.org>.
Andrew Wong has removed a vote on this change.

Change subject: [docs] Update the site build to use the release directory
......................................................................


Removed Verified-1 by Kudu Jenkins (120)
-- 
To view, visit http://gerrit.cloudera.org:8080/13835
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: deleteVote
Gerrit-Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Gerrit-Change-Number: 13835
Gerrit-PatchSet: 3
Gerrit-Owner: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)

[kudu-CR] [docs] Update the site build to use the release directory

Posted by "Andrew Wong (Code Review)" <ge...@cloudera.org>.
Andrew Wong has posted comments on this change. ( http://gerrit.cloudera.org:8080/13835 )

Change subject: [docs] Update the site build to use the release directory
......................................................................


Patch Set 3: Verified+1 Code-Review+2


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

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Gerrit-Change-Number: 13835
Gerrit-PatchSet: 3
Gerrit-Owner: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Comment-Date: Wed, 10 Jul 2019 21:42:07 +0000
Gerrit-HasComments: No

[kudu-CR] [docs] Update the site build to use the release directory

Posted by "Grant Henke (Code Review)" <ge...@cloudera.org>.
Grant Henke has submitted this change and it was merged. ( http://gerrit.cloudera.org:8080/13835 )

Change subject: [docs] Update the site build to use the release directory
......................................................................

[docs] Update the site build to use the release directory

Updates the make_site.sh script and make_docs.sh script
to generate docs in the versioned release directory. This
matches the new symbolic linking style we have been
using for the docs and avoids the need to manually copy
the docs during release.

An additional flag to skip updating the symbolic links (`—no-link`) was added.

Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Reviewed-on: http://gerrit.cloudera.org:8080/13835
Reviewed-by: Andrew Wong <aw...@cloudera.com>
Tested-by: Andrew Wong <aw...@cloudera.com>
---
M docs/support/scripts/make_docs.sh
M docs/support/scripts/make_site.sh
2 files changed, 54 insertions(+), 11 deletions(-)

Approvals:
  Andrew Wong: Looks good to me, approved; Verified

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

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: merged
Gerrit-Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Gerrit-Change-Number: 13835
Gerrit-PatchSet: 4
Gerrit-Owner: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)

[kudu-CR] [docs] Update the site build to use the release directory

Posted by "Andrew Wong (Code Review)" <ge...@cloudera.org>.
Andrew Wong has posted comments on this change. ( http://gerrit.cloudera.org:8080/13835 )

Change subject: [docs] Update the site build to use the release directory
......................................................................


Patch Set 1:

(3 comments)

http://gerrit.cloudera.org:8080/#/c/13835/1//COMMIT_MSG
Commit Message:

http://gerrit.cloudera.org:8080/#/c/13835/1//COMMIT_MSG@13
PS1, Line 13: durring
nit: during


http://gerrit.cloudera.org:8080/#/c/13835/1/docs/support/scripts/make_docs.sh
File docs/support/scripts/make_docs.sh:

http://gerrit.cloudera.org:8080/#/c/13835/1/docs/support/scripts/make_docs.sh@34
PS1, Line 34:   echo usage: "$0 --build_root <path to build root> [--site <path to gh-pages checkout>]"
Can you update this too?


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

PS1: 
I'm a little confused. Is this at all related to the other changes?



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

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Gerrit-Change-Number: 13835
Gerrit-PatchSet: 1
Gerrit-Owner: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Comment-Date: Wed, 10 Jul 2019 19:16:02 +0000
Gerrit-HasComments: Yes

[kudu-CR] [docs] Update the site build to use the release directory

Posted by "Grant Henke (Code Review)" <ge...@cloudera.org>.
Grant Henke has posted comments on this change. ( http://gerrit.cloudera.org:8080/13835 )

Change subject: [docs] Update the site build to use the release directory
......................................................................


Patch Set 1:

(1 comment)

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

PS1: 
> I see. Yeah, I'd prefer breaking it out, as trivial as it is. Kind of surpr
I broke it out.



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

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Gerrit-Change-Number: 13835
Gerrit-PatchSet: 1
Gerrit-Owner: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Comment-Date: Wed, 10 Jul 2019 21:06:23 +0000
Gerrit-HasComments: Yes

[kudu-CR] [docs] Update the site build to use the release directory

Posted by "Grant Henke (Code Review)" <ge...@cloudera.org>.
Grant Henke has posted comments on this change. ( http://gerrit.cloudera.org:8080/13835 )

Change subject: [docs] Update the site build to use the release directory
......................................................................


Patch Set 2:

(3 comments)

http://gerrit.cloudera.org:8080/#/c/13835/1//COMMIT_MSG
Commit Message:

http://gerrit.cloudera.org:8080/#/c/13835/1//COMMIT_MSG@13
PS1, Line 13: during 
> nit: during
Done


http://gerrit.cloudera.org:8080/#/c/13835/1/docs/support/scripts/make_docs.sh
File docs/support/scripts/make_docs.sh:

http://gerrit.cloudera.org:8080/#/c/13835/1/docs/support/scripts/make_docs.sh@34
PS1, Line 34:   echo usage: "$0 --build_root <path> --output_subdir <relative path> [--site <path to gh
> Can you update this too?
Done


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

PS1: 
> I'm a little confused. Is this at all related to the other changes?
Doxygen was failing on this because it couldn't generate docs for SetDiffScan. I included it as a commit note. I can break it out if you want. It just seemed to be trivial given it was a copy/paste.



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

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Gerrit-Change-Number: 13835
Gerrit-PatchSet: 2
Gerrit-Owner: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Comment-Date: Wed, 10 Jul 2019 19:21:49 +0000
Gerrit-HasComments: Yes

[kudu-CR] [docs] Update the site build to use the release directory

Posted by "Grant Henke (Code Review)" <ge...@cloudera.org>.
Hello Kudu Jenkins, Andrew Wong, 

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

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

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

Change subject: [docs] Update the site build to use the release directory
......................................................................

[docs] Update the site build to use the release directory

Updates the make_site.sh script and make_docs.sh script
to generate docs in the versioned release directory. This
matches the new symbolic linking style we have been
using for the docs and avoids the need to manually copy
the docs during release.

An additional flag to skip updating the symbolic links (`—no-link`) was added.

Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
---
M docs/support/scripts/make_docs.sh
M docs/support/scripts/make_site.sh
2 files changed, 54 insertions(+), 11 deletions(-)


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

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I174de2d7041bba20cdc3dcacd3efbb5e736ecb63
Gerrit-Change-Number: 13835
Gerrit-PatchSet: 3
Gerrit-Owner: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)