functions: fix remove_profiling documentation (simplify, focus on what it does)
[scilab.git] / scilab / modules / functions / help / en_US / profiling / remove_profiling.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ????-2008 - INRIA
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11 -->
12 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="remove_profiling" xml:lang="fr">
13     <refnamediv>
14         <refname>remove_profiling</refname>
15         <refpurpose>Disables the profiling of a function</refpurpose>
16     </refnamediv>
17     <refsynopsisdiv>
18         <title>Calling Sequence</title>
19         <synopsis>remove_profiling(funname)</synopsis>
20     </refsynopsisdiv>
21     <refsection>
22         <title>Arguments</title>
23         <variablelist>
24             <varlistentry>
25                 <term>funname</term>
26                 <listitem>
27                     <para>A character string, the name of the profiled function</para>
28                 </listitem>
29             </varlistentry>
30         </variablelist>
31     </refsection>
32     <refsection>
33         <title>Description</title>
34         <para>
35             <literal>remove_profiling</literal> removes the instructions needed for the profiling of a function.
36         </para>
37     </refsection>
38     <refsection>
39         <title>Examples</title>
40         <programlisting role="example"><![CDATA[ 
41 function x=foo(a,n)
42  x=0;
43  for i=1:n
44    if x<10 then
45      x=x+a
46    else
47      x=x+1
48    end  
49  end
50  x=x^2+1
51 endfunction
52
53 add_profiling("foo")
54 foo(0.1,100) //run the function
55 profile(foo) //extract profile information
56 remove_profiling("foo")
57  ]]></programlisting>
58     </refsection>
59     <refsection role="see also">
60         <title>See Also</title>
61         <simplelist type="inline">
62             <member>
63                 <link linkend="profile">profile</link>
64             </member>
65             <member>
66                 <link linkend="plotprofile">plotprofile</link>
67             </member>
68             <member>
69                 <link linkend="add_profiling">remove_profiling</link>
70             </member>
71             <member>
72                 <link linkend="reset_profiling">reset_profiling</link>
73             </member>
74         </simplelist>
75     </refsection>
76     <refsection>
77         <title>Used Functions</title>
78         <para>
79             This function uses the Scilab functions <literal>bytecode</literal>  and
80             <literal>walkbytecode</literal> 
81         </para>
82     </refsection>
83 </refentry>