[eclipse-poky] [PATCH 10/23] Add org.yocto.doc.user maven support
Tim Orling
timothy.t.orling at linux.intel.com
Thu Feb 8 23:17:44 PST 2018
* Uses org.codehaus.mojo exec-maven-plugin to run the
scripts/generate-doc.sh script
Signed-off-by: Tim Orling <timothy.t.orling at linux.intel.com>
---
.gitignore | 16 ++++++++++++++++
plugins/org.yocto.doc.user/pom.xml | 28 ++++++++++++++++++++++++++++
pom.xml | 37 ++++++++++++++++++++++++++++++++++++-
3 files changed, 80 insertions(+), 1 deletion(-)
create mode 100755 plugins/org.yocto.doc.user/pom.xml
diff --git a/.gitignore b/.gitignore
index 57f7687dab4..f46a43d9e98 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,19 @@ plugins/.metadata/
plugins/RemoteSystemsTempFiles/
runtime-EclipseApplication/
*/*/target/
+docs/
+plugins/org.yocto.doc.user/about.html
+plugins/org.yocto.doc.user/html/bsp-guide-toc.xml
+plugins/org.yocto.doc.user/html/bsp-guide/
+plugins/org.yocto.doc.user/html/dev-manual-toc.xml
+plugins/org.yocto.doc.user/html/dev-manual/
+plugins/org.yocto.doc.user/html/kernel-dev-toc.xml
+plugins/org.yocto.doc.user/html/kernel-dev/
+plugins/org.yocto.doc.user/html/profile-manual-toc.xml
+plugins/org.yocto.doc.user/html/profile-manual/
+plugins/org.yocto.doc.user/html/ref-manual-toc.xml
+plugins/org.yocto.doc.user/html/ref-manual/
+plugins/org.yocto.doc.user/html/sdk-manual-toc.xml
+plugins/org.yocto.doc.user/html/sdk-manual/
+plugins/org.yocto.doc.user/html/yocto-project-qs-toc.xml
+plugins/org.yocto.doc.user/html/yocto-project-qs/
diff --git a/plugins/org.yocto.doc.user/pom.xml b/plugins/org.yocto.doc.user/pom.xml
new file mode 100755
index 00000000000..66bc614e54c
--- /dev/null
+++ b/plugins/org.yocto.doc.user/pom.xml
@@ -0,0 +1,28 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>org.yocto</groupId>
+ <artifactId>org.yocto.doc.user</artifactId>
+ <packaging>eclipse-plugin</packaging>
+ <name>Yocto Project User Documentation</name>
+ <description>Yocto Project User Documentation (Eclipse Help) plugin</description>
+ <parent>
+ <groupId>org.yocto</groupId>
+ <artifactId>poky-parent</artifactId>
+ <version>1.4.1-SNAPSHOT</version>
+ <relativePath>../../pom.xml</relativePath>
+ </parent>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>exec-maven-plugin</artifactId>
+ <version>1.6.0</version>
+ <configuration>
+ <phase>generate-sources</phase>
+ <id>generate-docs</id>
+ <skip>false</skip>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+</project>
diff --git a/pom.xml b/pom.xml
index d948d1a30f7..389fa1fd66d 100755
--- a/pom.xml
+++ b/pom.xml
@@ -15,6 +15,7 @@
<help-docs-eclipserun-repo>http://download.eclipse.org/eclipse/updates/4.7</help-docs-eclipserun-repo>
<tycho.scmUrl>scm:git:https://github.com/crops/eclipse-poky.git</tycho.scmUrl>
<base.test.vmargs>-Xms256m -Xmx512m -ea</base.test.vmargs>
+ <yocto-docs-branch-name>master</yocto-docs-branch-name>
</properties>
<groupId>org.yocto</groupId>
@@ -46,6 +47,7 @@
<module>plugins/org.yocto.cmake.managedbuilder</module>
<module>plugins/org.yocto.remote.utils</module>
<module>plugins/org.yocto.sdk.remotetools</module>
+ <module>plugins/org.yocto.doc.user</module>
<!--
<module>releng/org.yocto.sdk.target.ui.tests</module>
-->
@@ -326,7 +328,7 @@
<groupId>org.yocto.releng</groupId>
<artifactId>poky</artifactId>
<classifier>${target-platform}</classifier>
- <version>1.4.1-SNAPSHOT</version>
+ <version>${project.version}</version>
</artifact>
</target>
</configuration>
@@ -404,6 +406,39 @@
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
+ <artifactId>exec-maven-plugin</artifactId>
+ <version>1.6.0</version>
+ <executions>
+ <execution>
+ <id>generate-docs</id>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>exec</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <executable>sh</executable>
+ <workingDirectory>${project.parent.basedir}/scripts/</workingDirectory>
+ <arguments>
+ <!-- Generate and add eclipse help from yocto's documentation
+ Usage: scripts/generate-doc.sh BRANCH_NAME | TAG_NAME PLUGIN_FOLDER
+
+ Options:
+ -h - display this help and exit
+ TAG_NAME - tag to build the documentation upon
+ BRANCH_NAME - branch to build the documentation upon
+ PLUGIN_FOLDER - root folder of the eclipse-poky project
+ -->
+ <argument>generate-doc.sh</argument>
+ <argument>${yocto-docs-branch-name}</argument>
+ <argument>${project.basedir}/../../</argument>
+ </arguments>
+ <skip>true</skip>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<version>3.0.4</version>
<configuration>
--
2.13.6
More information about the eclipse-yocto
mailing list