← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/core/help/en_US/debugging/setbpt.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/core/help/en_US/debugging/setbpt.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="setbpt" xml:lang="en">
3
 
  <refnamediv>
4
 
    <refname>setbpt</refname>
5
 
    <refpurpose>set breakpoints</refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>setbpt(macroname [,linenumb])</synopsis>
10
 
  </refsynopsisdiv>
11
 
  <refsection>
12
 
    <title>Arguments</title>
13
 
    <variablelist>
14
 
      <varlistentry>
15
 
        <term>macroname</term>
16
 
        <listitem>
17
 
          <para>a string</para>
18
 
        </listitem>
19
 
      </varlistentry>
20
 
      <varlistentry>
21
 
        <term>linenumb</term>
22
 
        <listitem>
23
 
          <para>a scalar integer or a vector of integers</para>
24
 
        </listitem>
25
 
      </varlistentry>
26
 
    </variablelist>
27
 
  </refsection>
28
 
  <refsection>
29
 
    <title>Description</title>
30
 
    <para>
31
 
      <literal>setbpt</literal> interactively inserts a breakpoint in the
32
 
      line number <literal>linenumb</literal> (default value is 1) of the
33
 
      function <literal>macroname</literal>.
34
 
    </para>
35
 
    <para>
36
 
      <literal>linenumb</literal> can be a line or column vector of line
37
 
      numbers, or a single scalar line number.
38
 
    </para>
39
 
    <para>
40
 
      Line numbers in <literal>linenumb</literal> are
41
 
      <emphasis>physical</emphasis> line numbers in function
42
 
      <literal>macroname</literal>. Note that Scilab versions before 5.0 used
43
 
      <emphasis>logical</emphasis> line numbers. The difference between physical
44
 
      and logical line numbers is the number of <emphasis>continued
45
 
        lines
46
 
      </emphasis>
47
 
      (see <link linkend="dot">dot</link>).
48
 
    </para>
49
 
    <para>When reaching a breakpoint, Scilab evaluates the specified physical
50
 
      line and stops the execution flow. If the function is not compiled (see
51
 
      <link linkend="comp">comp</link>) the line is printed on the screen. Then
52
 
      Scilab goes into a <link linkend="pause">pause</link> mode in which the
53
 
      user can check current values. The <link linkend="pause">pause</link> is
54
 
      exited with <link linkend="resume">resume</link> or <link linkend="abort">abort</link>.
55
 
    </para>
56
 
    <para>Redefining the function does not clear the breakpoints, the user
57
 
      must explicitly delete breakpoints using <link linkend="delbpt">delbpt</link>. The maximum number of functions with
58
 
      breakpoints enabled must be less than 100 and the overall maximum number
59
 
      of breakpoints is set to 1000.
60
 
    </para>
61
 
  </refsection>
62
 
  <refsection>
63
 
    <title>Examples</title>
64
 
    <programlisting role="example"><![CDATA[ 
 
3
    <refnamediv>
 
4
        <refname>setbpt</refname>
 
5
        <refpurpose>set breakpoints</refpurpose>
 
6
    </refnamediv>
 
7
    <refsynopsisdiv>
 
8
        <title>Calling Sequence</title>
 
9
        <synopsis>setbpt(macroname [,linenumb])</synopsis>
 
10
    </refsynopsisdiv>
 
11
    <refsection>
 
12
        <title>Arguments</title>
 
13
        <variablelist>
 
14
            <varlistentry>
 
15
                <term>macroname</term>
 
16
                <listitem>
 
17
                    <para>a string</para>
 
18
                </listitem>
 
19
            </varlistentry>
 
20
            <varlistentry>
 
21
                <term>linenumb</term>
 
22
                <listitem>
 
23
                    <para>a scalar integer or a vector of integers</para>
 
24
                </listitem>
 
25
            </varlistentry>
 
26
        </variablelist>
 
27
    </refsection>
 
28
    <refsection>
 
29
        <title>Description</title>
 
30
        <para>
 
31
            <literal>setbpt</literal> interactively inserts a breakpoint in the
 
32
            line number <literal>linenumb</literal> (default value is 1) of the
 
33
            function <literal>macroname</literal>.
 
34
        </para>
 
35
        <para>
 
36
            <literal>linenumb</literal> can be a line or column vector of line
 
37
            numbers, or a single scalar line number.
 
38
        </para>
 
39
        <para>
 
40
            Line numbers in <literal>linenumb</literal> are
 
41
            <emphasis>physical</emphasis> line numbers in function
 
42
            <literal>macroname</literal>. Note that Scilab versions before 5.0 used
 
43
            <emphasis>logical</emphasis> line numbers. The difference between physical
 
44
            and logical line numbers is the number of <emphasis>continued
 
45
                lines
 
46
            </emphasis>
 
47
            (see <link linkend="dot">dot</link>).
 
48
        </para>
 
49
        <para>When reaching a breakpoint, Scilab evaluates the specified physical
 
50
            line and stops the execution flow. If the function is not compiled (see
 
51
            <link linkend="comp">comp</link>) the line is printed on the screen. Then
 
52
            Scilab goes into a <link linkend="pause">pause</link> mode in which the
 
53
            user can check current values. The <link linkend="pause">pause</link> is
 
54
            exited with <link linkend="resume">resume</link> or <link linkend="abort">abort</link>.
 
55
        </para>
 
56
        <para>Redefining the function does not clear the breakpoints, the user
 
57
            must explicitly delete breakpoints using <link linkend="delbpt">delbpt</link>. The maximum number of functions with
 
58
            breakpoints enabled must be less than 100 and the overall maximum number
 
59
            of breakpoints is set to 1000.
 
60
        </para>
 
61
    </refsection>
 
62
    <refsection>
 
63
        <title>Examples</title>
 
64
        <programlisting role="example"><![CDATA[ 
65
65
setbpt('foo'),setbpt('foo',10),dispbpt()
66
66
delbpt()
67
67
 
68
68
setbpt('foo',[1,2,5,6]),dispbpt()
69
69
 ]]></programlisting>
70
 
  </refsection>
71
 
  <refsection role="see also">
72
 
    <title>See Also</title>
73
 
    <simplelist type="inline">
74
 
      <member>
75
 
        <link linkend="delbpt">delbpt</link>
76
 
      </member>
77
 
      <member>
78
 
        <link linkend="dispbpt">dispbpt</link>
79
 
      </member>
80
 
      <member>
81
 
        <link linkend="pause">pause</link>
82
 
      </member>
83
 
      <member>
84
 
        <link linkend="resume">resume</link>
85
 
      </member>
86
 
      <member>
87
 
        <link linkend="abort">abort</link>
88
 
      </member>
89
 
      <member>
90
 
        <link linkend="quit">quit</link>
91
 
      </member>
92
 
    </simplelist>
93
 
  </refsection>
 
70
    </refsection>
 
71
    <refsection role="see also">
 
72
        <title>See Also</title>
 
73
        <simplelist type="inline">
 
74
            <member>
 
75
                <link linkend="delbpt">delbpt</link>
 
76
            </member>
 
77
            <member>
 
78
                <link linkend="dispbpt">dispbpt</link>
 
79
            </member>
 
80
            <member>
 
81
                <link linkend="pause">pause</link>
 
82
            </member>
 
83
            <member>
 
84
                <link linkend="resume">resume</link>
 
85
            </member>
 
86
            <member>
 
87
                <link linkend="abort">abort</link>
 
88
            </member>
 
89
            <member>
 
90
                <link linkend="quit">quit</link>
 
91
            </member>
 
92
        </simplelist>
 
93
    </refsection>
94
94
</refentry>