commit cf320f2eda304cfd7049f43da21b30f683914a62
author Jonah Graham <jonah@kichwacoders.com> Tue Nov 12 19:54:49 2019 -0500
committer Karsten Thoms <karsten.thoms@itemis.de> Tue Dec 10 17:05:36 2019 -0500
tree f24b943ec20551f30077656316ecafded5916b6b
parent e0a498750f94cec99524828ba8e06f135551640f

Bug 543363: Document that formatter requires a workspace

Change-Id: Idd12bef4400793b8ed69a68ca59363e32abb2914
Signed-off-by: Jonah Graham <jonah@kichwacoders.com>

bundles/org.eclipse.jdt.doc.user/tasks/tasks-231.htm

diff --git a/bundles/org.eclipse.jdt.doc.user/tasks/tasks-231.htm b/bundles/org.eclipse.jdt.doc.user/tasks/tasks-231.htm
index baedea1..2cda021 100644
--- a/bundles/org.eclipse.jdt.doc.user/tasks/tasks-231.htm
+++ b/bundles/org.eclipse.jdt.doc.user/tasks/tasks-231.htm
@@ -22,7 +22,7 @@
       org.eclipse.jdt.core.JavaCodeFormatter application from the commandline:
     </p>
     <pre>
-    eclipse -vm &lt;path to virtual machine&gt; -application org.eclipse.jdt.core.JavaCodeFormatter [ OPTIONS ] &lt;files&gt;
+    eclipse -vm &lt;path to virtual machine&gt; -data &lt;workspace&gt; -application org.eclipse.jdt.core.JavaCodeFormatter [ OPTIONS ] &lt;files&gt;
 
     
 </pre>
@@ -31,6 +31,21 @@
 are computed relative to the current user directory.</p>
     <table border="1" cellspacing="0" cellpadding="5" width="600" summary="">
       <tr>
+        <td valign="top" width="25%">
+          <p>
+            -data &lt;workspace&gt;
+          </p>
+        </td>
+        <td valign="top">
+          <p>
+            The formatter requires a workspace to run. The workspace folder does
+            not have to exist and can be removed after the formatter is complete.
+            The recommended flow is to specify a unique temporary folder and remove
+            it on completion.
+          </p>
+        </td>
+      </tr>
+      <tr>
         <td width="25%">
           &lt;files&gt;
         </td>