xref: /aosp_15_r20/external/jacoco/org.jacoco.doc/xsl/cli.xsl (revision 7e63c1270baf9bfa84f5b6aecf17bd0c1a75af94)
1*7e63c127SSorin Basca<?xml version="1.0"?>
2*7e63c127SSorin Basca
3*7e63c127SSorin Basca<!--
4*7e63c127SSorin Basca   Copyright (c) 2009, 2018 Mountainminds GmbH & Co. KG and Contributors
5*7e63c127SSorin Basca   This program and the accompanying materials are made available under
6*7e63c127SSorin Basca   the terms of the Eclipse Public License 2.0 which is available at
7*7e63c127SSorin Basca   http://www.eclipse.org/legal/epl-2.0
8*7e63c127SSorin Basca
9*7e63c127SSorin Basca   SPDX-License-Identifier: EPL-2.0
10*7e63c127SSorin Basca
11*7e63c127SSorin Basca   Contributors:
12*7e63c127SSorin Basca      Marc R. Hoffmann - initial API and implementation
13*7e63c127SSorin Basca-->
14*7e63c127SSorin Basca
15*7e63c127SSorin Basca<xsl:stylesheet version="1.0"
16*7e63c127SSorin Basca	xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
17*7e63c127SSorin Basca	xmlns="http://www.w3.org/1999/xhtml" exclude-result-prefixes="xdoc">
18*7e63c127SSorin Basca
19*7e63c127SSorin Basca	<xsl:output method="xml" indent="yes" encoding="UTF-8"
20*7e63c127SSorin Basca		doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN" doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" />
21*7e63c127SSorin Basca
22*7e63c127SSorin Basca	<xsl:param name="qualified.bundle.version" />
23*7e63c127SSorin Basca	<xsl:param name="jacoco.home.url" />
24*7e63c127SSorin Basca	<xsl:param name="copyright.years" />
25*7e63c127SSorin Basca
26*7e63c127SSorin Basca	<xsl:template match="/">
27*7e63c127SSorin Basca		<html>
28*7e63c127SSorin Basca			<head>
29*7e63c127SSorin Basca				<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
30*7e63c127SSorin Basca				<link rel="stylesheet" href="resources/doc.css" charset="UTF-8"
31*7e63c127SSorin Basca					type="text/css" />
32*7e63c127SSorin Basca				<link rel="shortcut icon" href="resources/report.gif" type="image/gif" />
33*7e63c127SSorin Basca				<title>
34*7e63c127SSorin Basca					JaCoCo - Command Line Interface
35*7e63c127SSorin Basca				</title>
36*7e63c127SSorin Basca			</head>
37*7e63c127SSorin Basca			<body>
38*7e63c127SSorin Basca				<div class="breadcrumb">
39*7e63c127SSorin Basca					<a href="../index.html" class="el_report">JaCoCo</a> &gt;
40*7e63c127SSorin Basca					<a href="index.html" class="el_group">Documentation</a> &gt;
41*7e63c127SSorin Basca					<span class="el_source">Command Line Interface</span>
42*7e63c127SSorin Basca				</div>
43*7e63c127SSorin Basca				<div id="content">
44*7e63c127SSorin Basca
45*7e63c127SSorin Basca					<h1>Command Line Interface</h1>
46*7e63c127SSorin Basca
47*7e63c127SSorin Basca					<p>
48*7e63c127SSorin Basca					  JaCoCo comes with a command line interface to perform
49*7e63c127SSorin Basca					  basic operations from the command line. The command line
50*7e63c127SSorin Basca					  tools with all dependencies are packaged in
51*7e63c127SSorin Basca					  <code>jacococli.jar</code> and are available with the
52*7e63c127SSorin Basca					  JaCoCo download. Java 1.5 or greater is required for
53*7e63c127SSorin Basca					  execution.
54*7e63c127SSorin Basca					</p>
55*7e63c127SSorin Basca
56*7e63c127SSorin Basca					<p>
57*7e63c127SSorin Basca					  For more sophisticated usage especially with larger
58*7e63c127SSorin Basca					  projects please use our
59*7e63c127SSorin Basca					  <a href="integrations.html">integrations</a> with various
60*7e63c127SSorin Basca					  build tools.
61*7e63c127SSorin Basca					</p>
62*7e63c127SSorin Basca
63*7e63c127SSorin Basca					<p>
64*7e63c127SSorin Basca					  The following commands are available. Each command has a
65*7e63c127SSorin Basca					  list of optional and required parameters. Some parameters
66*7e63c127SSorin Basca					  can be specified multiple times to provide multiple values.
67*7e63c127SSorin Basca					</p>
68*7e63c127SSorin Basca
69*7e63c127SSorin Basca					<p class="hint">
70*7e63c127SSorin Basca					  <b>Warning:</b> Although a <code>instrument</code> command
71*7e63c127SSorin Basca					  is provided the preferred way for code coverage analysis
72*7e63c127SSorin Basca					  with JaCoCo is on-the-fly instrumentation with the
73*7e63c127SSorin Basca					  <a href="agent.html">JaCoCo agent</a>. Offline
74*7e63c127SSorin Basca					  instrumentation has several drawbacks and should only be
75*7e63c127SSorin Basca					  used if a specific scenario explicitly requires this mode.
76*7e63c127SSorin Basca					  Please consult <a href="offline.html">documentation</a>
77*7e63c127SSorin Basca					  about offline instrumentation before using this mode.
78*7e63c127SSorin Basca					</p>
79*7e63c127SSorin Basca
80*7e63c127SSorin Basca					<xsl:apply-templates select="documentation" />
81*7e63c127SSorin Basca				</div>
82*7e63c127SSorin Basca				<div class="footer">
83*7e63c127SSorin Basca					<span class="right">
84*7e63c127SSorin Basca						<a href="{$jacoco.home.url}">JaCoCo</a>
85*7e63c127SSorin Basca						&#160;
86*7e63c127SSorin Basca						<xsl:value-of select="$qualified.bundle.version" />
87*7e63c127SSorin Basca					</span>
88*7e63c127SSorin Basca					<a href="../doc/license.html">Copyright</a>
89*7e63c127SSorin Basca					&#169;
90*7e63c127SSorin Basca					<xsl:value-of select="$copyright.years" />
91*7e63c127SSorin Basca					Mountainminds GmbH &amp; Co. KG and Contributors
92*7e63c127SSorin Basca				</div>
93*7e63c127SSorin Basca			</body>
94*7e63c127SSorin Basca		</html>
95*7e63c127SSorin Basca	</xsl:template>
96*7e63c127SSorin Basca
97*7e63c127SSorin Basca	<xsl:template match="command">
98*7e63c127SSorin Basca		<h2><xsl:value-of select="@name" /></h2>
99*7e63c127SSorin Basca		<pre class="source" style="white-space: pre-wrap">
100*7e63c127SSorin Basca			<xsl:value-of select="usage" />
101*7e63c127SSorin Basca		</pre>
102*7e63c127SSorin Basca		<p><xsl:value-of select="description" /></p>
103*7e63c127SSorin Basca		<table class="coverage">
104*7e63c127SSorin Basca			<thead>
105*7e63c127SSorin Basca				<tr>
106*7e63c127SSorin Basca					<td>Option</td>
107*7e63c127SSorin Basca					<td>Description</td>
108*7e63c127SSorin Basca					<td>Required</td>
109*7e63c127SSorin Basca					<td>Multiple</td>
110*7e63c127SSorin Basca				</tr>
111*7e63c127SSorin Basca			</thead>
112*7e63c127SSorin Basca			<tbody>
113*7e63c127SSorin Basca				<xsl:for-each select="option">
114*7e63c127SSorin Basca					<tr>
115*7e63c127SSorin Basca						<td><code><xsl:value-of select="usage" /></code></td>
116*7e63c127SSorin Basca						<td><xsl:value-of select="description" /></td>
117*7e63c127SSorin Basca						<td style="text-align:center"><xsl:if test="@required = 'true'">&#x25fc;</xsl:if></td>
118*7e63c127SSorin Basca						<td style="text-align:center"><xsl:if test="@multiple = 'true'">&#x25fc;</xsl:if></td>
119*7e63c127SSorin Basca					</tr>
120*7e63c127SSorin Basca				</xsl:for-each>
121*7e63c127SSorin Basca			</tbody>
122*7e63c127SSorin Basca		</table>
123*7e63c127SSorin Basca	</xsl:template>
124*7e63c127SSorin Basca
125*7e63c127SSorin Basca</xsl:stylesheet>
126