dita-ot-docs/topics/enabling-debug-mode.dita at develop · DeltaXML/dita-ot-docs · GitHub

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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
<!--  This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license.  -->
<task id="t-enabling-debug-mode">
  <title>Enabling debug mode</title>
  <shortdesc>Debug logging prints considerably more additional information. The debug log includes all information from
    the verbose log, plus details on Java classes, additional Ant properties and overrides, preprocessing filters,
    parameters, and stages, and the complete build sequence. The debug log can help you determine the root cause of a
    problem.</shortdesc>
  <prolog>
    <metadata>
      <keywords>
        <indexterm><xmlelement>property</xmlelement></indexterm>
        <indexterm>command line
          <indexterm>debugging</indexterm></indexterm>
        <indexterm><cmdname>dita</cmdname> command
          <indexterm>debugging</indexterm></indexterm>
        <indexterm>debugging
          <indexterm>args.debug</indexterm></indexterm>
        <indexterm>environment variables</indexterm>
        <indexterm>stack trace</indexterm>
        <indexterm>args.debug</indexterm>
        <indexterm>Ant
          <indexterm>args.debug</indexterm></indexterm>
      </keywords>
    </metadata>
  </prolog>
  <taskbody>
    <steps>
      <step>
        <cmd>From the command prompt, add the following parameters:</cmd>
        <choicetable>
          <chhead>
            <choptionhd>Application</choptionhd>
            <chdeschd>Parameters</chdeschd>
          </chhead>
          <chrow>
            <choption><cmdname>dita</cmdname> command</choption>
            <chdesc><parmname>--debug</parmname>, <parmname>-debug</parmname>, or <parmname>-d</parmname></chdesc>
          </chrow>
          <chrow>
            <choption>Ant</choption>
            <chdesc><codeph>-v -Dargs.debug=yes</codeph></chdesc>
          </chrow>
        </choicetable>
        <info>
          <p>You also can add a <xmlelement>property</xmlelement> element to an Ant target in your build file, for
            example: <codeblock outputclass="language-xml">&lt;property name="args.debug" value="yes"/></codeblock></p>
          <note type="attention">Debug logging requires additional resources and can slow down the build process, so it
            should only be enabled when further details are required to diagnose problems.</note>
        </info>
      </step>
    </steps>
  </taskbody>
</task>