Update sitedocs for branch main

eclipse-tycho · Feb 15, 2024 · 98cc1b3 · 98cc1b3
1 parent a1f5e67
commit 98cc1b3
Show file tree

Hide file tree

Showing 2 changed files with 155 additions and 0 deletions.
diff --git a/doc/main/tycho-extras/tycho-dependency-tools-plugin/generate-target-mojo.html b/doc/main/tycho-extras/tycho-dependency-tools-plugin/generate-target-mojo.html
@@ -0,0 +1,152 @@
+<!DOCTYPE html>
+
+
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.11.0:report at 2024-02-15
+ | Rendered using Apache Maven Fluido Skin 1.11.1
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
+    <title>Tycho Dependency Tools Plugin &#x2013; tycho-dependency-tools:generate-target</title>
+    <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.1.min.css" />
+    <link rel="stylesheet" href="./css/site.css" />
+    <link rel="stylesheet" href="./css/print.css" media="print" />
+    <script src="./js/apache-maven-fluido-1.11.1.min.js"></script>
+  </head>
+  <body class="topBarDisabled">
+    <div class="container-fluid">
+      <header>
+        <div id="banner">
+          <div class="pull-left"><div id="bannerLeft"><h1>Tycho Dependency Tools Plugin</h1>
+</div>
+</div>
+          <div class="pull-right"></div>
+          <div class="clear"><hr/></div>
+        </div>
+
+        <div id="breadcrumbs">
+          <ul class="breadcrumb">
+        <li id="publishDate">Last Published: 2024-02-15<span class="divider">|</span>
+</li>
+          <li id="projectVersion">Version: 5.0.0-SNAPSHOT</li>
+          </ul>
+        </div>
+      </header>
+      <div class="row-fluid">
+        <header id="leftColumn" class="span2">
+          <nav class="well sidebar-nav">
+  <ul class="nav nav-list">
+   <li class="nav-header">Using Tycho</li>
+    <li><a href="../../index.html" title="Overview"><span class="none"></span>Overview</a></li>
+    <li><a href="../../StructuredBuild.html" title="Structured Build Layout and Pomless Builds"><span class="none"></span>Structured Build Layout and Pomless Builds</a></li>
+    <li><a href="../../BndBuild.html" title="BND Workspace and Pomless Builds"><span class="icon-chevron-down"></span>BND Workspace and Pomless Builds</a>
+     <ul class="nav nav-list">
+      <li><a href="../../tycho-bnd-plugin/plugin-info.html" title="Tycho BND Plugin"><span class="none"></span>Tycho BND Plugin</a></li>
+     </ul></li>
+    <li><a href="../../PackagingTypes.html" title="Packaging Types"><span class="icon-chevron-down"></span>Packaging Types</a>
+     <ul class="nav nav-list">
+      <li><a href="../../tycho-packaging-plugin/plugin-info.html" title="Tycho Packaging Plugin"><span class="none"></span>Tycho Packaging Plugin</a></li>
+     </ul></li>
+    <li><a href="../../TargetPlatform.html" title="Target Platform"><span class="icon-chevron-down"></span>Target Platform</a>
+     <ul class="nav nav-list">
+      <li><a href="../../target-platform-configuration/plugin-info.html" title="Target Platform Configuration Plugin"><span class="none"></span>Target Platform Configuration Plugin</a></li>
+      <li><a href="../../tycho-extras/target-platform-validation-plugin/plugin-info.html" title="Target Platform Validation Plugin"><span class="none"></span>Target Platform Validation Plugin</a></li>
+     </ul></li>
+    <li><a href="../../TestingBundles.html" title="Testing Bundles"><span class="icon-chevron-down"></span>Testing Bundles</a>
+     <ul class="nav nav-list">
+      <li><a href="../../tycho-surefire-plugin/plugin-info.html" title="Tycho Surefire Plugin"><span class="none"></span>Tycho Surefire Plugin</a></li>
+     </ul></li>
+    <li><a href="../../TychoCiFriendly.html" title="Tycho CI Friendly Versions"><span class="none"></span>Tycho CI Friendly Versions</a></li>
+    <li><a href="../../Category.html" title="Creating update sites using category.xml"><span class="icon-chevron-down"></span>Creating update sites using category.xml</a>
+     <ul class="nav nav-list">
+      <li><a href="../../tycho-p2-repository-plugin/plugin-info.html" title="Tycho P2 Repository Plugin"><span class="none"></span>Tycho P2 Repository Plugin</a></li>
+     </ul></li>
+    <li><a href="" title="Properties"><span class="icon-chevron-down"></span>Properties</a>
+     <ul class="nav nav-list">
+      <li><a href="../../BuildProperties.html" title="Build Properties"><span class="none"></span>Build Properties</a></li>
+      <li><a href="../../SystemProperties.html" title="System Properties"><span class="none"></span>System Properties</a></li>
+      <li><a href="../../TychoProperties.html" title="Tycho Properties"><span class="none"></span>Tycho Properties</a></li>
+     </ul></li>
+   <li class="nav-header">Other Tycho Plugins</li>
+    <li><a href="../../tycho-baseline-plugin/plugin-info.html" title="Baseline Plugin"><span class="none"></span>Baseline Plugin</a></li>
+    <li><a href="../../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin"><span class="none"></span>Compiler Plugin</a></li>
+    <li><a href="../../tycho-ds-plugin/plugin-info.html" title="Declarative Services Plugin"><span class="none"></span>Declarative Services Plugin</a></li>
+    <li><a href="../../tycho-extras/tycho-document-bundle-plugin/plugin-info.html" title="Document Bundle Plugin"><span class="none"></span>Document Bundle Plugin</a></li>
+    <li><a href="../../tycho-eclipse-plugin/plugin-info.html" title="Eclipse Plugin"><span class="none"></span>Eclipse Plugin</a></li>
+    <li><a href="../../tycho-gpg-plugin/plugin-info.html" title="GPG Signature Plugin"><span class="none"></span>GPG Signature Plugin</a></li>
+    <li><a href="../../tycho-p2-director-plugin/plugin-info.html" title="P2 Director Plugin"><span class="none"></span>P2 Director Plugin</a></li>
+    <li><a href="../../tycho-p2-plugin/plugin-info.html" title="P2 Metadata Plugin"><span class="none"></span>P2 Metadata Plugin</a></li>
+    <li><a href="../../tycho-p2-publisher-plugin/plugin-info.html" title="P2 Publisher Plugin"><span class="none"></span>P2 Publisher Plugin</a></li>
+    <li><a href="../../tycho-extras/tycho-p2-extras-plugin/plugin-info.html" title="P2 Extras Plugin"><span class="none"></span>P2 Extras Plugin</a></li>
+    <li><a href="../../tycho-apitools-plugin/plugin-info.html" title="PDE API Tools Plugin"><span class="none"></span>PDE API Tools Plugin</a></li>
+    <li><a href="../../tycho-source-plugin/plugin-info.html" title="Source Plugin"><span class="none"></span>Source Plugin</a></li>
+    <li><a href="../../tycho-versions-plugin/plugin-info.html" title="Versions Plugin"><span class="none"></span>Versions Plugin</a></li>
+   <li class="nav-header">Project Documentation</li>
+    <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
+    <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li>
+  </ul>
+          </nav>
+          <div class="well sidebar-nav">
+            <div id="poweredBy">
+              <div class="clear"></div>
+              <div class="clear"></div>
+              <div class="clear"></div>
+<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+            </div>
+          </div>
+        </header>
+        <main id="bodyColumn"  class="span10" >
+<section>
+<h2><a name="tycho-dependency-tools:generate-target"></a>tycho-dependency-tools:generate-target</h2><a name="tycho-dependency-tools:generate-target"></a>
+<p><strong>Full name</strong>:</p>
+<p>org.eclipse.tycho.extras:tycho-dependency-tools-plugin:5.0.0-SNAPSHOT:generate-target</p>
+<p><strong>Description</strong>:</p>
+<p>This mojo generates a target platform from all the dependencies of a maven build for example to be used inside of PDE</p>
+<p><strong>Attributes</strong>:</p>
+<ul>
+<li>Requires a Maven project to be executed.</li>
+<li>Executes as an aggregator goal.</li>
+<li>The goal is thread-safe and supports parallel builds.</li></ul><section>
+<h3><a name="Required_Parameters"></a>Required Parameters</h3><a name="Required_Parameters"></a>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Name</th>
+<th>Type</th>
+<th>Since</th>
+<th>Description</th></tr>
+<tr class="b">
+<td align="left"><a href="#targetFile"><code>&lt;targetFile&gt;</code></a></td>
+<td><code>File</code></td>
+<td><code>-</code></td>
+<td>No description.<br /><strong>Default</strong>: <code>${project.build.directory}/generate.target</code><br /><strong>User Property</strong>: <code>generateTargetFile</code></td></tr></table></section><section>
+<h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="targetFile"><section>
+<h4><a name="a.3CtargetFile.3E"></a>&lt;targetFile&gt;</h4><a name="a.3CtargetFile.3E"></a></a>
+<div>No description.</div>
+<ul>
+<li><strong>Type</strong>: <code>java.io.File</code></li>
+<li><strong>Required</strong>: <code>Yes</code></li>
+<li><strong>User Property</strong>: <code>generateTargetFile</code></li>
+<li><strong>Default</strong>: <code>${project.build.directory}/generate.target</code></li></ul></section></section></section>
+        </main>
+      </div>
+    </div>
+    <hr/>
+    <footer>
+      <div class="container-fluid">
+        <div class="row-fluid">
+            <p>&#169;      2008&#x2013;2024
+<a href="https://www.eclipse.org/">Eclipse Foundation</a>
+</p>
+        </div>
+      </div>
+    </footer>
+<script>
+	if(anchors) {
+	  anchors.add();
+	}
+</script>
+  </body>
+</html>
diff --git a/doc/main/tycho-extras/tycho-dependency-tools-plugin/plugin-info.html b/doc/main/tycho-extras/tycho-dependency-tools-plugin/plugin-info.html
@@ -112,6 +112,9 @@ <h3><a name="Goals"></a>Goals</h3><a name="Goals"></a>
 <th>Goal</th>
 <th>Description</th></tr>
 <tr class="b">
+<td align="left"><a href="./generate-target-mojo.html">tycho-dependency-tools:generate-target</a></td>
+<td>This mojo generates a target platform from all the dependencies of a maven build for example to be used inside of PDE</td></tr>
+<tr class="a">
 <td align="left"><a href="./list-dependencies-mojo.html">tycho-dependency-tools:list-dependencies</a></td>
 <td>Builds a .target file describing the dependencies for current project. It differs from <code>maven-dependency-plugin:list</code> in the fact that it does return location to bundles, and not to nested jars (in case bundle contain some).</td></tr></table></section><section>
 <h3><a name="System_Requirements"></a>System Requirements</h3><a name="System_Requirements"></a>