forked from pantsbuild/pantsbuild.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
export.html
507 lines (484 loc) · 22.2 KB
/
export.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
<!DOCTYPE html>
<html lang="en">
<!--
Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).
Licensed under the Apache License, Version 2.0 (see LICENSE).
-->
<head>
<meta charset="utf-8"/>
<title>Export Format</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="pants-logo.ico">
<!-- In case this is a "test publish", tell search engines where real version lives: -->
<link rel="canonical" href="http://pantsbuild.org/export.html">
<link rel="stylesheet" href="bootstrap-custom.min.css">
<link rel="stylesheet" href="bootstrap-custom-theme.min.css">
<link rel="stylesheet" href="docsite.css">
</head>
<body>
<div class="header">
<nav class="navbar navbar-default navbar-static-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand navbar-brand-img" href="index.html">
<img src="pants-logo.ico" alt="[pantsbuild logo]">
</a>
<a class="navbar-brand" href="index.html">
Pants
</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="/">Docs</a></li>
<li><a href="community.html">Community</a></li>
<li><a href="https://www.github.com/pantsbuild/pants">GitHub</a></li>
<li>
<form class="navbar-form navbar-left search" role="search" action="https://www.google.com/search">
<div class="form-group">
<input type="text" name="as_q" class="form-control query" placeholder="Search">
<input name="as_sitesearch" value="pantsbuild.org" type="hidden">
</div>
</form>
</li>
</ul>
</div><!--/.nav-collapse -->
</div>
</nav>
</div>
<div class="page">
<div class="container-fluid">
<div class="row">
<div class="col-md-1">
</div>
<div class="col-md-2">
<div class="site-toc">
<ul>
<li class="toc-h1 toc-heading">
Getting Started
</li>
<li class="toc-h1 toc-link ">
<a href="install.html">Installing Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="setup_repo.html">Setting Up Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="first_tutorial.html">Tutorial</a>
</li>
<li class="toc-h1 toc-link ">
<a href="common_tasks.html">Common Tasks</a>
</li>
<li class="toc-h1 toc-heading">
Pants Basics
</li>
<li class="toc-h1 toc-link ">
<a href="why_use_pants.html">Why Use Pants?</a>
</li>
<li class="toc-h1 toc-link ">
<a href="first_concepts.html">Pants Concepts</a>
</li>
<li class="toc-h1 toc-link ">
<a href="build_files.html">BUILD files</a>
</li>
<li class="toc-h1 toc-link ">
<a href="target_addresses.html">Target Addresses</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty.html">Third-Party Dependencies</a>
</li>
<li class="toc-h1 toc-link ">
<a href="options.html">Pants Options</a>
</li>
<li class="toc-h1 toc-link ">
<a href="invoking.html">Invoking Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="reporting_server.html">Reporting Server</a>
</li>
<li class="toc-h1 toc-link ">
<a href="ide_support.html">IDE Support</a>
</li>
<li class="toc-h1 toc-heading">
JVM
</li>
<li class="toc-h1 toc-link ">
<a href="jvm_projects.html">JVM Projects with Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty_jvm.html">JVM 3rdparty Pattern</a>
</li>
<li class="toc-h1 toc-link ">
<a href="scala.html">Scala Support</a>
</li>
<li class="toc-h1 toc-link ">
<a href="publish.html">Publishing Artifacts</a>
</li>
<li class="toc-h1 toc-link ">
<a href="from_maven.html">Pants for Maven Experts</a>
</li>
<li class="toc-h1 toc-heading">
Python
</li>
<li class="toc-h1 toc-link ">
<a href="python_readme.html">Python Projects with Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty_py.html">Python 3rdparty Pattern</a>
</li>
<li class="toc-h1 toc-heading">
Go
</li>
<li class="toc-h1 toc-link ">
<a href="go_readme.html">Go support for Pants</a>
</li>
<li class="toc-h1 toc-heading">
Codegen
</li>
<li class="toc-h1 toc-link ">
<a href="thrift_deps.html">Thrift</a>
</li>
<li class="toc-h1 toc-heading">
Docgen
</li>
<li class="toc-h1 toc-link ">
<a href="page.html">Markdown</a>
</li>
<li class="toc-h1 toc-heading">
Getting Help
</li>
<li class="toc-h1 toc-link ">
<a href="tshoot.html">Troubleshooting</a>
</li>
<li class="toc-h1 toc-link ">
<a href="community.html">Community</a>
</li>
<li class="toc-h1 toc-heading">
Reference
</li>
<li class="toc-h1 toc-link ">
<a href="build_dictionary.html">Pants BUILD Dictionary</a>
</li>
<li class="toc-h1 toc-link ">
<a href="options_reference.html">Pants Reference</a>
</li>
<li class="toc-h1 toc-heading">
Release Notes
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.3.x.html">1.3.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.2.x.html">1.2.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.1.x.html">1.1.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.0.x.html">1.0.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-master.html">Master Pre-Releases</a>
</li>
<li class="toc-h1 toc-heading">
Developer
</li>
<li class="toc-h1 toc-link ">
<a href="dev.html">Pants Developer Center</a>
</li>
<li class="toc-h1 toc-link toc-here">
Export Format
</li>
</ul>
</div> <!-- site-toc -->
</div>
<div class="col-md-8">
<div class="content">
<div class="mainflow">
<nav class="pagetoc">
<ul>
<li class="toc-h1"><a href="#export-format">Export Format</a></li>
<li class="toc-h1"><a href="#top-level-fields">Top Level fields</a></li>
<li class="toc-h2"><a href="#version">Version</a></li>
<li class="toc-h2"><a href="#libraries">Libraries</a></li>
<li class="toc-h2"><a href="#targets">Targets</a></li>
<li class="toc-h1"><a href="#example-export-output">Example export output</a></li>
<li class="toc-h1"><a href="#export-format-changes">Export Format Changes</a></li>
<li class="toc-h2"><a href="#109">1.0.9</a></li>
<li class="toc-h2"><a href="#108">1.0.8</a></li>
<li class="toc-h2"><a href="#107">1.0.7</a></li>
<li class="toc-h2"><a href="#106">1.0.6</a></li>
<li class="toc-h2"><a href="#105">1.0.5</a></li>
<li class="toc-h2"><a href="#104">1.0.4</a></li>
<li class="toc-h2"><a href="#103">1.0.3</a></li>
<li class="toc-h2"><a href="#102">1.0.2</a></li>
<li class="toc-h2"><a href="#101">1.0.1</a></li>
<li class="toc-h2"><a href="#100">1.0.0</a></li>
</ul>
</nav>
<!-- main content start -->
<!-- generated by pants! -->
<style>
.codehilite .hll { background-color: #ffffcc }
.codehilite { background: #f0f0f0; }
.codehilite .c { color: #60a0b0; font-style: italic } /* Comment */
.codehilite .err { border: 1px solid #FF0000 } /* Error */
.codehilite .k { color: #007020; font-weight: bold } /* Keyword */
.codehilite .o { color: #666666 } /* Operator */
.codehilite .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
.codehilite .cp { color: #007020 } /* Comment.Preproc */
.codehilite .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
.codehilite .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
.codehilite .gd { color: #A00000 } /* Generic.Deleted */
.codehilite .ge { font-style: italic } /* Generic.Emph */
.codehilite .gr { color: #FF0000 } /* Generic.Error */
.codehilite .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.codehilite .gi { color: #00A000 } /* Generic.Inserted */
.codehilite .go { color: #808080 } /* Generic.Output */
.codehilite .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.codehilite .gs { font-weight: bold } /* Generic.Strong */
.codehilite .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.codehilite .gt { color: #0040D0 } /* Generic.Traceback */
.codehilite .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.codehilite .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.codehilite .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.codehilite .kp { color: #007020 } /* Keyword.Pseudo */
.codehilite .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.codehilite .kt { color: #902000 } /* Keyword.Type */
.codehilite .m { color: #40a070 } /* Literal.Number */
.codehilite .s { color: #4070a0 } /* Literal.String */
.codehilite .na { color: #4070a0 } /* Name.Attribute */
.codehilite .nb { color: #007020 } /* Name.Builtin */
.codehilite .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.codehilite .no { color: #60add5 } /* Name.Constant */
.codehilite .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.codehilite .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.codehilite .ne { color: #007020 } /* Name.Exception */
.codehilite .nf { color: #06287e } /* Name.Function */
.codehilite .nl { color: #002070; font-weight: bold } /* Name.Label */
.codehilite .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.codehilite .nt { color: #062873; font-weight: bold } /* Name.Tag */
.codehilite .nv { color: #bb60d5 } /* Name.Variable */
.codehilite .ow { color: #007020; font-weight: bold } /* Operator.Word */
.codehilite .w { color: #bbbbbb } /* Text.Whitespace */
.codehilite .mf { color: #40a070 } /* Literal.Number.Float */
.codehilite .mh { color: #40a070 } /* Literal.Number.Hex */
.codehilite .mi { color: #40a070 } /* Literal.Number.Integer */
.codehilite .mo { color: #40a070 } /* Literal.Number.Oct */
.codehilite .sb { color: #4070a0 } /* Literal.String.Backtick */
.codehilite .sc { color: #4070a0 } /* Literal.String.Char */
.codehilite .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.codehilite .s2 { color: #4070a0 } /* Literal.String.Double */
.codehilite .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.codehilite .sh { color: #4070a0 } /* Literal.String.Heredoc */
.codehilite .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.codehilite .sx { color: #c65d09 } /* Literal.String.Other */
.codehilite .sr { color: #235388 } /* Literal.String.Regex */
.codehilite .s1 { color: #4070a0 } /* Literal.String.Single */
.codehilite .ss { color: #517918 } /* Literal.String.Symbol */
.codehilite .bp { color: #007020 } /* Name.Builtin.Pseudo */
.codehilite .vc { color: #bb60d5 } /* Name.Variable.Class */
.codehilite .vg { color: #bb60d5 } /* Name.Variable.Global */
.codehilite .vi { color: #bb60d5 } /* Name.Variable.Instance */
.codehilite .il { color: #40a070 } /* Literal.Number.Integer.Long */
</style>
<h1 id="export-format">Export Format</h1>
<p>The configuration for a set of targets can be exported out of pants into JSON format using
the <code>pants export</code> goal. This could useful for integrating Pants with another build tool.
The <a href="https://github.com/pantsbuild/intellij-pants-plugin">Pants Support IntelliJ plugin</a> uses
the export goal to get information out of Pants to configure IntelliJ.</p>
<p>This page captures the specification of the data provided by the export goal.
See the Changelog section below for differences between versions of the export format.</p>
<h1 id="top-level-fields">Top Level fields</h1>
<ul>
<li>"version" : A string representing the version number of the export format.</li>
<li>"libraries" : Dictionary of paths to .jar files resolved by pants required to compile the
project.</li>
<li>"targets" : Dictionary of targets defined in BUILD files.</li>
<li>"distributions" : Information about JVM distributions.</li>
<li>"jvm_platforms" : Information about JVM platforms(language level and additionals arguments).</li>
<li>"python_setup" : Information about Python setup(interpreters and chroots for them).</li>
</ul>
<h2 id="version">Version</h2>
<p>Version number for identifying the export file format output. This version number will
change when there is a change to the output format. The version number specification is as follows:</p>
<p><code><major_version>.<minor_version>.<patch_version></code></p>
<ul>
<li><code><major_version></code> : Increment this field when there is a major format change</li>
<li><code><minor_version></code> : Increment this field when there is a minor change that breaks backward
compatibility for an existing field or a field is removed.</li>
<li><code><patch_version></code> : Increment this field when a minor format change that just adds information
that an application can safely ignore.</li>
</ul>
<h2 id="libraries">Libraries</h2>
<p>Represents all of the external jars that have been resolved by pants. The value for libraries
is represented by a dictionary as follows:</p>
<p><code>{ <jar_coordinate> : { <conf_name> : <jar_file> } }</code></p>
<ul>
<li><code><jar_coordinate></code> : key representing this jar. Usually <code><org>:<name>:<rev></code></li>
<li><code><conf_name></code> : Ivy conf this jar was resolved for. Usually one of <code>default</code>, <code>sources</code>,
or <code>javadoc</code></li>
<li><code><jar_file></code> : Path to the resolved jar file.</li>
</ul>
<h2 id="targets">Targets</h2>
<p>The targets field contains all of the targets exported from pants BUILD file definitions. The
value for targets is represented by a dctionary of target specs mapped to a dictionary of the
fields defined in the target:</p>
<p><code>{ <target_spec> : <target_field_mapping> }</code></p>
<ul>
<li><code><target_spec></code> : <code>"<path_to_build_file>:<target_name>"</code></li>
<li><code><target_field_mapping></code> : Dictionary of target fields (TBD)</li>
</ul>
<h1 id="example-export-output">Example export output</h1>
<p>The following is an abbreviated export file from a command in the pants repo:</p>
<div class="codehilite"><pre>{
"version": "1.0.4",
"libraries": {
"commons-logging:commons-logging:1.1.1": {
"default": "/Users/user/.ivy2/pants/commons-logging/commons-logging/jars/commons-logging-1.1.1.jar"
},
"commons-codec:commons-codec:1.6": {
"default": "/Users/user/.ivy2/pants/commons-codec/commons-codec/jars/commons-codec-1.6.jar"
},
"org.apache.httpcomponents:httpclient:4.2.5": {
"default": "/Users/user/.ivy2/pants/org.apache.httpcomponents/httpclient/jars/httpclient-4.2.5.jar"
},
...
},
# distributions settings provided as an example from another repo
"distributions": {
"darwin": [
"/Library/Java/JavaVirtualMachines/jdk1.8.0_45.jdk/Contents/Home",
"/Library/Java/JavaVirtualMachines/jdk1.7.0_80.jdk/Contents/Home"
],
"linux": [
"/usr/java/jdk1.8.0_45",
"/usr/java/jdk1.7.0_80"
]
},
"jvm_platforms": {
"platforms": {
"java6": {
"source_level": "1.6",
"args": [],
"target_level": "1.6"
}
},
"default_platform": "java6"
},
"python_setup": {
"interpreters": {
"CPython-2.7.10": {
"binary": "/Users/user/pants/build-support/pants_dev_deps.venv/bin/python2.7",
"chroot": "/Users/user/pants/.pants.d/python-setup/chroots/e8da2c200f36ca0a1b8a60c12590a59209250b1a"
}
},
"default_interpreter": "CPython-2.7.10"
},
"targets": {
"examples/tests/java/org/pantsbuild/example/usethrift:usethrift": {
"is_code_gen": false,
"excludes": [],
"target_type": "TEST",
"libraries": [
"junit:junit:4.12",
"org.hamcrest:hamcrest-core:1.3",
"junit:junit:latest.integration"
],
"platform": "java6",
"pants_target_type": "junit_tests",
"globs": {
"globs": [
"examples/tests/java/org/pantsbuild/example/usethrift/UseThriftTest.java"
]
},
"targets": [
"3rdparty:junit",
"examples/src/thrift/org/pantsbuild/example/distance:distance-java",
"examples/src/thrift/org/pantsbuild/example/precipitation:precipitation-java",
".pants.d/gen/thrift/isolated/examples.src.thrift.org.pantsbuild.example.distance.distance-java:examples.src.thrift.org.pantsbuild.example.distance.distance-java",
".pants.d/gen/thrift/isolated/examples.src.thrift.org.pantsbuild.example.precipitation.precipitation-java:examples.src.thrift.org.pantsbuild.example.precipitation.precipitation-java"
],
"roots": [
{
"source_root": "/Users/user/pants/examples/tests/java/org/pantsbuild/example/usethrift",
"package_prefix": "org.pantsbuild.example.usethrift"
}
]
},
"examples/src/python/example/hello/greet:greet": {
"is_code_gen": false,
"python_interpreter": "CPython-2.7.10",
"target_type": "SOURCE",
"libraries": [],
"pants_target_type": "python_library",
"globs": {
"globs": [
"examples/src/python/example/hello/greet/*.py"
]
},
"targets": [
"3rdparty/python:ansicolors"
],
"roots": [
{
"source_root": "/Users/user/pants/examples/src/python/example/hello/greet",
"package_prefix": "example.hello.greet"
}
]
},
...
}
}
</pre></div>
<h1 id="export-format-changes">Export Format Changes</h1>
<h2 id="109">1.0.9</h2>
<p>Added 'is_target_root' field to target</p>
<h2 id="108">1.0.8</h2>
<p>Conditionally added 'transitive' and 'scope' fields to target</p>
<h2 id="107">1.0.7</h2>
<p>Added 'test_platform' to target and 'preferred_jvm_distributions' section</p>
<h2 id="106">1.0.6</h2>
<p>Added 'is_synthetic' field to target</p>
<h2 id="105">1.0.5</h2>
<p>Added 'id' to target</p>
<h2 id="104">1.0.4</h2>
<p>If a target class is registered under multiple aliases returns the last one</p>
<h2 id="103">1.0.3</h2>
<p>Added information about jdk settings</p>
<h2 id="102">1.0.2</h2>
<p>Handle jars with classifiers</p>
<h2 id="101">1.0.1</h2>
<p>Information about excludes</p>
<h2 id="100">1.0.0</h2>
<p>Initial Version</p>
<!-- main content end -->
<div class="generated">
Generated by <a href="docs.html">publish_docs</a>
from dist/markdown/html/src/docs/export.html 2017-05-29T10:30:50.590411
</div>
</div> <!-- mainflow -->
</div> <!-- content -->
</div>
<div class="col-md-1">
</div>
</div> <!-- row -->
</div> <!-- container-fluid -->
</div> <!-- page -->
<script src="https://code.jquery.com/jquery-2.2.3.min.js" integrity="sha384-I6F5OKECLVtK/BL+8iSLDEHowSAfUo76ZL9+kGAgTRdiByINKJaqTPH/QVNS1VDb" crossorigin="anonymous"></script>
<script src="bootstrap-custom.min.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-78111411-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>