reducing-processing-time.dita 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" >
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <topic id="reducing-processing-time" xml:lang="en-US">
  5. <title>Reducing processing time</title>
  6. <shortdesc>Several configuration changes can significantly reduce DITA-OT processing time.</shortdesc>
  7. <prolog>
  8. <metadata>
  9. <keywords>
  10. <indexterm><xmlatt>xtrf</xmlatt></indexterm>
  11. <indexterm><xmlatt>xtrc</xmlatt></indexterm>
  12. <indexterm>processing time</indexterm>
  13. <indexterm>Java<indexterm>required version</indexterm></indexterm>
  14. <indexterm>debugging<indexterm>generate-debug-attributes</indexterm></indexterm>
  15. </keywords>
  16. </metadata>
  17. </prolog>
  18. <body>
  19. <section>
  20. <title>Disable debug attribute generation</title>
  21. <p>The <parmname>generate-debug-attributes</parmname> parameter determines whether debugging attributes are
  22. generated in the temporary files. By changing the value to <codeph>false</codeph>, DITA-OT will no longer
  23. generate the <xmlatt>xtrf</xmlatt> and <xmlatt>xtrc</xmlatt> debug attributes. This will make it more
  24. difficult to track down the source file location from which a given issue may have originated, but it will
  25. reduce the size of the temporary files. As a result, XML parsing will take less time and overall processing
  26. time will be reduced.</p>
  27. </section>
  28. <section>
  29. <title>Use a fast disk for the temporary directory</title>
  30. <p>DITA-OT keeps topic and map files as separate files and processes each file multiple times during
  31. preprocessing. Thus reading from disk, parsing XML, serializing XML, and writing to disk makes processing
  32. quite I/O intensive. Use either an
  33. <xref href="http://en.wikipedia.org/wiki/Solid-state_drive" scope="external" format="html">SSD</xref> or a
  34. <xref href="http://en.wikipedia.org/wiki/RAM_drive" scope="external" format="html">RAM disk</xref> for
  35. temporary files, and never use a temporary directory that is not located on the same machine as where the
  36. processing takes place.</p>
  37. </section>
  38. <section>
  39. <title>Reuse the JVM instance</title>
  40. <p>For all but extremely large source sets, the JVM will not have enough time to warm-up. By reusing the same
  41. JVM instance, the first few DITA-OT conversions will be “normal”, but when the JIT starts to kick in, the
  42. performance increase may be 2-10 fold. This is especially noticeable with smaller source sets, as much of
  43. the DITA-OT processing is I/O intensive.</p>
  44. </section>
  45. <section>
  46. <title>Use the latest Java version</title>
  47. <p>DITA-OT 2.0 to 2.3 require Java 7, and DITA-OT 2.4 and newer require Java 8. However, using a newer version
  48. of Java can further reduce processing time.</p>
  49. </section>
  50. </body>
  51. <related-links>
  52. <linklist>
  53. <title>Collected links</title>
  54. <link href="http://en.wikipedia.org/wiki/Solid-state_drive" scope="external" format="html">
  55. <linktext>SSD</linktext>
  56. </link>
  57. <link href="http://en.wikipedia.org/wiki/RAM_drive" scope="external" format="html">
  58. <linktext>RAM disk</linktext>
  59. </link>
  60. </linklist>
  61. </related-links>
  62. </topic>