You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@sqoop.apache.org by Jarek Cecho <ja...@apache.org> on 2016/02/07 19:10:19 UTC
Review Request 43315: SQOOP-2827: Sqoop2: Doc: Provide doc
preprocessor facilities
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/43315/
-----------------------------------------------------------
Review request for Sqoop and Jarek Cecho.
Bugs: SQOOP-2827
https://issues.apache.org/jira/browse/SQOOP-2827
Repository: sqoop-sqoop2
Description
-------
In order to solve SQOOP-2826 I need facilities to execute pre-processing steps while generating documentation.
Diffs
-----
docs/pom.xml c96a582
docs/src/main/java/org/apache/sqoop/docs/generator/DocPreprocessor.java PRE-CREATION
docs/src/main/java/org/apache/sqoop/docs/generator/plugins/AbstractPlugin.java PRE-CREATION
docs/src/main/java/org/apache/sqoop/docs/generator/plugins/CopySourceToDestination.java PRE-CREATION
docs/src/main/resources/log4j.properties PRE-CREATION
pom.xml ba0a243
Diff: https://reviews.apache.org/r/43315/diff/
Testing
-------
Thanks,
Jarek Cecho
Re: Review Request 43315: SQOOP-2827: Sqoop2: Doc: Provide doc
preprocessor facilities
Posted by Jarek Cecho <ja...@apache.org>.
> On Feb. 8, 2016, 7:22 p.m., Abraham Fine wrote:
> > docs/pom.xml, line 72
> > <https://reviews.apache.org/r/43315/diff/1/?file=1237090#file1237090line72>
> >
> > what is the reason for this change? shouldn't the documentation be generated during the "site" goal?
>
> Jarek Cecho wrote:
> So that is a maven playing badly on us. The "site" goal is actually not part of standard lifecycle, but an extra one (similarly to clean). So when one does "mvn package", the "site" goal is not necessarily called. And since our docs are primarily targetted for the being included in package, I've decided to move them to this goal to ensure that our binary package always have them. I could move the doc generation to "site" goal and update our "How to release guide" to call "mvn clean site package", but that seemed quite fragile to me. What do you think?
We had a small chat with Abe offline where he correctly pointed out that without this patch, the sphinx plugin runs executed via "mvn site" as well as "mvn package". However with this patch it's executed only for "mvn package".
I've took a deeper look and I think that I do understand what happened now. I've added a new plugin exec-maven-plugin that is doing the doc pregeneration. Sadly this plugin can't run inside "reporting" tag as the sphinx-maven-plugin is, so I put it into "build" tag. But then the sphinx-maven-plugin was executed before exec-maven-plugin (which is undesirable), so I've moved sphinx-maven-plugin from "reporting" to "build" and suddenly everything was working so I was happy.
I did not realized that by moving sphinx plugin from "reporting" tag, it's no longer called on "mvn site". I've uploaded new patch that adds execution of both exec-maven-plugin and sphinx-maven-plugin to be run inside "site" target in addition to "package" target that I put there before. So with the new version, the documentation is generate on both "mvn site" and "mvn package" targets.
- Jarek
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/43315/#review118275
-----------------------------------------------------------
On Feb. 12, 2016, 10:05 p.m., Jarek Cecho wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/43315/
> -----------------------------------------------------------
>
> (Updated Feb. 12, 2016, 10:05 p.m.)
>
>
> Review request for Sqoop and Jarek Cecho.
>
>
> Bugs: SQOOP-2827
> https://issues.apache.org/jira/browse/SQOOP-2827
>
>
> Repository: sqoop-sqoop2
>
>
> Description
> -------
>
> In order to solve SQOOP-2826 I need facilities to execute pre-processing steps while generating documentation.
>
>
> Diffs
> -----
>
> docs/pom.xml c96a582
> docs/src/main/java/org/apache/sqoop/docs/generator/DocPreprocessor.java PRE-CREATION
> docs/src/main/java/org/apache/sqoop/docs/generator/plugins/AbstractPlugin.java PRE-CREATION
> docs/src/main/java/org/apache/sqoop/docs/generator/plugins/CopySourceToDestination.java PRE-CREATION
> docs/src/main/resources/log4j.properties PRE-CREATION
> pom.xml ba0a243
>
> Diff: https://reviews.apache.org/r/43315/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> Jarek Cecho
>
>
Re: Review Request 43315: SQOOP-2827: Sqoop2: Doc: Provide doc
preprocessor facilities
Posted by Jarek Cecho <ja...@apache.org>.
> On Feb. 8, 2016, 7:22 p.m., Abraham Fine wrote:
> > docs/pom.xml, line 72
> > <https://reviews.apache.org/r/43315/diff/1/?file=1237090#file1237090line72>
> >
> > what is the reason for this change? shouldn't the documentation be generated during the "site" goal?
So that is a maven playing badly on us. The "site" goal is actually not part of standard lifecycle, but an extra one (similarly to clean). So when one does "mvn package", the "site" goal is not necessarily called. And since our docs are primarily targetted for the being included in package, I've decided to move them to this goal to ensure that our binary package always have them. I could move the doc generation to "site" goal and update our "How to release guide" to call "mvn clean site package", but that seemed quite fragile to me. What do you think?
- Jarek
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/43315/#review118275
-----------------------------------------------------------
On Feb. 7, 2016, 6:10 p.m., Jarek Cecho wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/43315/
> -----------------------------------------------------------
>
> (Updated Feb. 7, 2016, 6:10 p.m.)
>
>
> Review request for Sqoop and Jarek Cecho.
>
>
> Bugs: SQOOP-2827
> https://issues.apache.org/jira/browse/SQOOP-2827
>
>
> Repository: sqoop-sqoop2
>
>
> Description
> -------
>
> In order to solve SQOOP-2826 I need facilities to execute pre-processing steps while generating documentation.
>
>
> Diffs
> -----
>
> docs/pom.xml c96a582
> docs/src/main/java/org/apache/sqoop/docs/generator/DocPreprocessor.java PRE-CREATION
> docs/src/main/java/org/apache/sqoop/docs/generator/plugins/AbstractPlugin.java PRE-CREATION
> docs/src/main/java/org/apache/sqoop/docs/generator/plugins/CopySourceToDestination.java PRE-CREATION
> docs/src/main/resources/log4j.properties PRE-CREATION
> pom.xml ba0a243
>
> Diff: https://reviews.apache.org/r/43315/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> Jarek Cecho
>
>
Re: Review Request 43315: SQOOP-2827: Sqoop2: Doc: Provide doc
preprocessor facilities
Posted by Abraham Fine <ab...@abrahamfine.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/43315/#review118275
-----------------------------------------------------------
docs/pom.xml (line 72)
<https://reviews.apache.org/r/43315/#comment179502>
what is the reason for this change? shouldn't the documentation be generated during the "site" goal?
- Abraham Fine
On Feb. 7, 2016, 6:10 p.m., Jarek Cecho wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/43315/
> -----------------------------------------------------------
>
> (Updated Feb. 7, 2016, 6:10 p.m.)
>
>
> Review request for Sqoop and Jarek Cecho.
>
>
> Bugs: SQOOP-2827
> https://issues.apache.org/jira/browse/SQOOP-2827
>
>
> Repository: sqoop-sqoop2
>
>
> Description
> -------
>
> In order to solve SQOOP-2826 I need facilities to execute pre-processing steps while generating documentation.
>
>
> Diffs
> -----
>
> docs/pom.xml c96a582
> docs/src/main/java/org/apache/sqoop/docs/generator/DocPreprocessor.java PRE-CREATION
> docs/src/main/java/org/apache/sqoop/docs/generator/plugins/AbstractPlugin.java PRE-CREATION
> docs/src/main/java/org/apache/sqoop/docs/generator/plugins/CopySourceToDestination.java PRE-CREATION
> docs/src/main/resources/log4j.properties PRE-CREATION
> pom.xml ba0a243
>
> Diff: https://reviews.apache.org/r/43315/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> Jarek Cecho
>
>
Re: Review Request 43315: SQOOP-2827: Sqoop2: Doc: Provide doc
preprocessor facilities
Posted by Abraham Fine <ab...@abrahamfine.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/43315/#review119106
-----------------------------------------------------------
Ship it!
Ship It!
- Abraham Fine
On Feb. 12, 2016, 10:05 p.m., Jarek Cecho wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/43315/
> -----------------------------------------------------------
>
> (Updated Feb. 12, 2016, 10:05 p.m.)
>
>
> Review request for Sqoop and Jarek Cecho.
>
>
> Bugs: SQOOP-2827
> https://issues.apache.org/jira/browse/SQOOP-2827
>
>
> Repository: sqoop-sqoop2
>
>
> Description
> -------
>
> In order to solve SQOOP-2826 I need facilities to execute pre-processing steps while generating documentation.
>
>
> Diffs
> -----
>
> docs/pom.xml c96a582
> docs/src/main/java/org/apache/sqoop/docs/generator/DocPreprocessor.java PRE-CREATION
> docs/src/main/java/org/apache/sqoop/docs/generator/plugins/AbstractPlugin.java PRE-CREATION
> docs/src/main/java/org/apache/sqoop/docs/generator/plugins/CopySourceToDestination.java PRE-CREATION
> docs/src/main/resources/log4j.properties PRE-CREATION
> pom.xml ba0a243
>
> Diff: https://reviews.apache.org/r/43315/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> Jarek Cecho
>
>
Re: Review Request 43315: SQOOP-2827: Sqoop2: Doc: Provide doc
preprocessor facilities
Posted by Jarek Cecho <ja...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/43315/
-----------------------------------------------------------
(Updated Feb. 12, 2016, 10:05 p.m.)
Review request for Sqoop and Jarek Cecho.
Bugs: SQOOP-2827
https://issues.apache.org/jira/browse/SQOOP-2827
Repository: sqoop-sqoop2
Description
-------
In order to solve SQOOP-2826 I need facilities to execute pre-processing steps while generating documentation.
Diffs (updated)
-----
docs/pom.xml c96a582
docs/src/main/java/org/apache/sqoop/docs/generator/DocPreprocessor.java PRE-CREATION
docs/src/main/java/org/apache/sqoop/docs/generator/plugins/AbstractPlugin.java PRE-CREATION
docs/src/main/java/org/apache/sqoop/docs/generator/plugins/CopySourceToDestination.java PRE-CREATION
docs/src/main/resources/log4j.properties PRE-CREATION
pom.xml ba0a243
Diff: https://reviews.apache.org/r/43315/diff/
Testing
-------
Thanks,
Jarek Cecho