Review Board 1.7.22


FLUME-1262: Move doc generation to a different profile

Review Request #10555 - Created April 16, 2013 and submitted

Mike Percy
FLUME-1262
Reviewers
Flume
flume-git
Moved stuff around
Works both with and without specifying -Psite
Also builds only the docs if you run: mvn clean site javadoc:aggregate-jar -> leaves them in target/site

Diff revision 2 (Latest)

1 2
1 2

  1. pom.xml: Loading...
  2. flume-ng-dist/src/main/assembly/bin.xml: Loading...
  3. flume-ng-node/pom.xml: Loading...
pom.xml
Revision 9aff211 New Change
[20] 59 lines
[+20]
60
    <module>flume-ng-sdk</module>
60
    <module>flume-ng-sdk</module>
61
    <module>flume-ng-tests</module>
61
    <module>flume-ng-tests</module>
62
  </modules>
62
  </modules>
63

    
   
63

   
64
  <profiles>
64
  <profiles>

    
   
65

   
65
    <profile>
66
    <profile>
66
      <id>hadoop-1.0</id>
67
      <id>hadoop-1.0</id>
67
      <activation>
68
      <activation>
68
        <property>
69
        <property>
69
          <name>!hadoop.profile</name>
70
          <name>!hadoop.profile</name>
[+20] [20] 107 lines
[+20]
177
          </plugin>
178
          </plugin>
178
        </plugins>
179
        </plugins>
179
      </build>
180
      </build>
180
    </profile>
181
    </profile>
181

    
   
182

   
182

    
   

   
183
    <!-- maven 2 & 3 compat for reporting plugin -->

   
184
    <profile>
183
    <profile>
185
      <id>maven-3</id>
184
      <id>site</id>
186
      <activation>
185

   
187
        <file>

   
188
          <!--  This employs that the basedir expression is only recognized by Maven 3.x (see MNG-2363) -->

   
189
          <exists>${basedir}</exists>

   
190
        </file>

   
191
      </activation>

   
192
      <build>
186
      <build>
193
        <plugins>
187
        <plugins>

    
   
188

   
Moved from 457

    
   
189
          <plugin>
Moved from 458

    
   
190
            <artifactId>maven-javadoc-plugin</artifactId>

    
   
191
            <executions>

    
   
192
              <execution>

    
   
193
                <id>javadoc-jar</id>

    
   
194
                <phase>package</phase>

    
   
195
                <goals>

    
   
196
                  <goal>aggregate-jar</goal>

    
   
197
                </goals>

    
   
198
              </execution>

    
   
199
            </executions>

    
   
200
          </plugin>

    
   
201

   
194
          <plugin>
202
          <plugin>

    
   
203
            <groupId>org.apache.maven.plugins</groupId>
195
            <artifactId>maven-site-plugin</artifactId>
204
            <artifactId>maven-site-plugin</artifactId>
196
            <executions>
205
            <executions>
197
              <execution>
206
              <execution>
198
                <id>attach-descriptor</id>
207
                <id>flume-site</id>

    
   
208
                <phase>package</phase>
199
                <goals>
209
                <goals>
200
                  <goal>attach-descriptor</goal>
210
                  <goal>site</goal>
201
                </goals>
211
                </goals>
202
              </execution>
212
              </execution>

    
   
213
              <!--

    
   
214
              <execution>

    
   
215
                <id>flume-site-dist</id>

    
   
216
                <phase>package</phase>

    
   
217
                <goals>

    
   
218
                  <goal>stage</goal>

    
   
219
                </goals>

    
   
220
              </execution>

    
   
221
              -->
203
            </executions>
222
            </executions>
204
          </plugin>
223
          </plugin>

    
   
224

   
205
        </plugins>
225
        </plugins>
206
      </build>
226
      </build>

    
   
227

   
207
    </profile>
228
    </profile>

    
   
229

   
208
  </profiles>
230
  </profiles>
209

    
   
231

   
210
  <inceptionYear>2009</inceptionYear>
232
  <inceptionYear>2009</inceptionYear>
211

    
   
233

   
212
  <issueManagement>
234
  <issueManagement>
[+20] [20] 234 lines
[+20]
447
  </distributionManagement>
469
  </distributionManagement>
448

    
   
470

   
449
  <build>
471
  <build>
450

    
   
472

   
451
    <plugins>
473
    <plugins>

    
   
474

   
452
      <plugin>
475
      <plugin>
453
        <groupId>org.apache.rat</groupId>
476
        <groupId>org.apache.rat</groupId>
454
        <artifactId>apache-rat-plugin</artifactId>
477
        <artifactId>apache-rat-plugin</artifactId>
455
      </plugin>
478
      </plugin>
456

    
   
479

   
457
      <plugin>

   
458
        <artifactId>maven-javadoc-plugin</artifactId>

   
459
        <version>2.8.1</version>

   
460
        <executions>

   
461
          <execution>

   
462
            <id>javadoc-jar</id>

   
463
            <phase>package</phase>

   
464
            <goals>

   
465
              <goal>aggregate-jar</goal>

   
466
            </goals>

   
467
            <configuration>

   
468
              <!-- switch on dependency-driven aggregation -->
Moved to 556

   
469
              <includeDependencySources>true</includeDependencySources>
Moved to 557

   
470

    
   

   
471
              <dependencySourceIncludes>

   
472
                <!-- include ONLY flume multi-module dependencies -->

   
473
                <dependencySourceInclude>org.apache.flume:*</dependencySourceInclude>

   
474
              </dependencySourceIncludes>

   
475
            </configuration>

   
476
          </execution>

   
477
        </executions>

   
478
      </plugin>

   
479
    </plugins>
480
    </plugins>
480

    
   
481

   
481
    <pluginManagement>
482
    <pluginManagement>
482
      <plugins>
483
      <plugins>
483

    
   
484

   
[+20] [20] 61 lines
[+20]
545
            </execution>
546
            </execution>
546
          </executions>
547
          </executions>
547
        </plugin>
548
        </plugin>
548

    
   
549

   
549
        <plugin>
550
        <plugin>
550
          <groupId>org.tomdz.maven</groupId>
551
          <groupId>org.apache.maven.plugins</groupId>
551
          <artifactId>sphinx-maven-plugin</artifactId>
552
          <artifactId>maven-javadoc-plugin</artifactId>
552
          <version>1.0.2</version>
553
          <version>2.9</version>

    
   
554
          <configuration>

    
   
555
            <outputDirectory>${project.build.directory}/site/apidocs</outputDirectory>
Moved from 468

    
   
556
            <!-- switch on dependency-driven aggregation -->
Moved from 469

    
   
557
            <includeDependencySources>true</includeDependencySources>

    
   
558

   

    
   
559
            <dependencySourceIncludes>

    
   
560
              <!-- include ONLY flume multi-module dependencies -->

    
   
561
              <dependencySourceInclude>org.apache.flume:*</dependencySourceInclude>

    
   
562
            </dependencySourceIncludes>

    
   
563
          </configuration>
553
        </plugin>
564
        </plugin>
554

    
   
565

   
555
        <plugin>
566
        <plugin>
556
          <groupId>org.apache.maven.plugins</groupId>
567
          <groupId>org.apache.maven.plugins</groupId>
557
          <artifactId>maven-assembly-plugin</artifactId>
568
          <artifactId>maven-assembly-plugin</artifactId>
558
          <version>2.3</version>
569
          <version>2.3</version>
559
        </plugin>
570
        </plugin>
560

    
   
571

   
561
        <plugin>
572
        <plugin>
562
          <groupId>org.apache.avro</groupId>
573
          <groupId>org.apache.avro</groupId>
563
          <artifactId>avro-maven-plugin</artifactId>
574
          <artifactId>avro-maven-plugin</artifactId>
564
          <!--

   
565
          <configuration>

   
566
            <stringType>String</stringType>

   
567
          </configuration>

   
568
          -->

   
569
          <version>${avro.version}</version>
575
          <version>${avro.version}</version>
570
        </plugin>
576
        </plugin>
571

    
   
577

   
572
        <plugin>
578
        <plugin>
573
          <groupId>com.thoughtworks.paranamer</groupId>
579
          <groupId>com.thoughtworks.paranamer</groupId>
[+20] [20] 6 lines
[+20]
580
          <artifactId>maven-site-plugin</artifactId>
586
          <artifactId>maven-site-plugin</artifactId>
581
          <version>3.1</version>
587
          <version>3.1</version>
582
          <configuration>
588
          <configuration>
583
            <siteDirectory>${project.basedir}/flume-ng-doc</siteDirectory>
589
            <siteDirectory>${project.basedir}/flume-ng-doc</siteDirectory>
584
          </configuration>
590
          </configuration>
585
          <dependencies>

   
586
          </dependencies>

   
587
          <executions>

   
588
            <execution>

   
589
              <id>flume-site</id>

   
590
              <phase>package</phase>

   
591
              <goals>

   
592
                <goal>site</goal>

   
593
              </goals>

   
594
            </execution>

   
595
            <execution>

   
596
              <id>flume-site-dist</id>

   
597
              <phase>package</phase>

   
598
              <goals>

   
599
                <goal>stage</goal>

   
600
              </goals>

   
601
            </execution>

   
602
          </executions>

   
603
        </plugin>
591
        </plugin>
604

    
   
592

   
605
        <plugin>

   
606
          <artifactId>maven-clean-plugin</artifactId>

   
607
          <version>2.4.1</version>

   
608
          <configuration>

   
609
            <filesets>

   
610
              <fileset>

   
611
                <directory>flume-docs</directory>

   
612
                <includes>

   
613
                  <include>**</include>

   
614
                </includes>

   
615
              </fileset>

   
616
            </filesets>

   
617
          </configuration>

   
618
        </plugin>

   
619
      </plugins>
593
      </plugins>
620

    
   
594

   
621
    </pluginManagement>
595
    </pluginManagement>
622

    
   
596

   
623
  </build>
597
  </build>
[+20] [20] 358 lines
[+20]
982
        <groupId>org.apache.flume</groupId>
956
        <groupId>org.apache.flume</groupId>
983
        <artifactId>flume-ng-embedded-agent</artifactId>
957
        <artifactId>flume-ng-embedded-agent</artifactId>
984
        <version>1.4.0-SNAPSHOT</version>
958
        <version>1.4.0-SNAPSHOT</version>
985
      </dependency>
959
      </dependency>
986

    
   
960

   
987

    
   

   
988
      <dependency>
961
      <dependency>
989
        <groupId>com.sun.jersey</groupId>
962
        <groupId>com.sun.jersey</groupId>
990
        <artifactId>jersey-core</artifactId>
963
        <artifactId>jersey-core</artifactId>
991
        <version>1.8</version>
964
        <version>1.8</version>
992
      </dependency>
965
      </dependency>
[+20] [20] 35 lines
[+20]
1028
    </dependencies>
1001
    </dependencies>
1029
  </dependencyManagement>
1002
  </dependencyManagement>
1030

    
   
1003

   
1031
  <reporting>
1004
  <reporting>
1032
    <plugins>
1005
    <plugins>

    
   
1006

   
1033
      <plugin>
1007
      <plugin>
1034
        <groupId>org.apache.maven.plugins</groupId>
1008
        <groupId>org.apache.maven.plugins</groupId>
1035
        <artifactId>maven-project-info-reports-plugin</artifactId>
1009
        <artifactId>maven-project-info-reports-plugin</artifactId>
1036
        <version>2.4</version>
1010
        <version>2.4</version>
1037
        <reportSets>
1011
        <reportSets>
[+20] [20] 7 lines
[+20]
1045
              <report>modules</report>
1019
              <report>modules</report>
1046
              <report>dependencies</report>
1020
              <report>dependencies</report>
1047
              <report>cim</report>
1021
              <report>cim</report>
1048
              <report>scm</report>
1022
              <report>scm</report>
1049
-->
1023
-->

    
   
1024
              <!-- warning: the "about" report conflicts with sphinx-maven -->
1050
            </reports>
1025
            </reports>
1051
          </reportSet>
1026
          </reportSet>
1052
        </reportSets>
1027
        </reportSets>
1053
      </plugin>
1028
      </plugin>
1054

    
   
1029

   
[+20] [20] 14 lines
flume-ng-dist/src/main/assembly/bin.xml
Revision ad939d5 New Change
 
flume-ng-node/pom.xml
Revision 035ae06 New Change
 
  1. pom.xml: Loading...
  2. flume-ng-dist/src/main/assembly/bin.xml: Loading...
  3. flume-ng-node/pom.xml: Loading...