Author:halw

Date:2011-01-17T18:16:06.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@739 abb3cda0-5349-4a8f-a601-0c33ac3a8c38

documentation/current/community/index.wiki

@@ -19,6 +19,30 @@ Each documentation page has an associated '''Comments''' page. Any viewer can ad
 # '''Any material you add to this site becomes the property of Eiffel Software, and may be shared with the community.'''
 # Comments pages should ''not'' be used for product support questions, product feature requests, or bug reports. ''Comments of this sort will be deleted.'' For help with products join the [http://eiffel.com/developers/usergroup.html Eiffel Software User Group] and use the resources at the [http://community.eiffel.com Eiffel Community site]. 
 
+=====Comment lifecycle=====
+
+Although the procedure for how editors deal with comments is flexible, some general guidelines can be given:
+
+# For comments requesting action (e. g., fix a problem, add more information):
+## For those actions which can be accomplished immediately:
+### The comment will not be published.
+### The requested action will be fixed.
+### The original comment's subject line will be prepended with "FIXED".
+## For those actions which cannot be accomplished quickly or require special handling:
+### The comment will be published
+### A response to the comment will be made via "reply", and
+#### The original comment's subject line will be prepended with:
+##### FIXED, if and when the request can be satisfied.
+##### ANALYZED, otherwise, plus explanation of delayed or not acting on request.
+## For actions affecting docs.eiffel.com plus the Eiffel distribution:
+### Submit a problem report requesting feedback when problem is fixed so that docs.eiffel.com can be updated in kind.
+# For comments not requesting action, but adding relevant information related to the page:
+## The comment will be published.
+## If appropriate: 
+### The content of the comment will be integrated into the page.
+### The original comment's subject line prepended with FIXED.
+# Periodically, an audit will remove older comments marked as FIXED and ANALYZED.
+
 ===Contributors and Editors===
 
 If you are interested in a more active role in improving and developing EiffelStudio documentation, you can become:

documentation/current/eiffelstudio/eiffelstudio-how-tos/running-and-debugging/tracing.wiki

@@ -153,7 +153,68 @@ end
 
 In <code>EXAMPLE_HANDLER</code> the procedure <code>trace</code> is effected to write the desired information to the <code>log_file</code>. 
 
-The application using <code>EXAMPLE_HANDLER</code> might look like this:
+Then we could use <code>EXAMPLE_HANDLER</code> in a class that might look like this:
+
+<code>
+class
+    APPLICATION
+
+create
+    make
+
+feature
+
+    make
+            -- Run application.
+        local
+            tracing_setting: TRACING_SETTING
+            tracing_handler: EXAMPLE_HANDLER
+        do
+            create tracing_setting
+            tracing_setting.enable_tracing
+            create tracing_handler
+            tracing_handler.activate
+
+            call_depth_one
+
+            tracing_handler.deactivate
+            tracing_handler.close_log_file
+            tracing_setting.disable_tracing
+    end
+
+    call_depth_one
+            -- Call depth one routine
+        do
+            call_depth_two
+        end
+
+    call_depth_two
+            -- Call depth two routine
+        do
+            call_depth_three
+        end
+
+    call_depth_three
+            -- Call depth three routine
+        do
+
+        end
+end
+</code>
+
+In <code>{APPLICATION}.make</code>, the instances of <code>TRACING_SETTING</code> and <code>EXAMPLE_HANDLER</code> are created. Tracing is enabled and the handler is activated. After the section of interest, the handler is deactivated, the log file closed, and tracing disabled.
+
+Now consider a system in which <code>{APPLICATION}.make</code> is the root, <code>APPLICATION</code> is the only class in the root cluster, and that the project setting '''Trace''' is true for the root cluster only. After running the system, the content of <code>my_log_file.txt</code> would be:
+
+<code lang="text">
+> Is entering {APPLICATION}.call_depth_one
+>> Is entering {APPLICATION}.call_depth_two
+>>> Is entering {APPLICATION}.call_depth_three
+>>> Is leaving  {APPLICATION}.call_depth_three
+>> Is leaving  {APPLICATION}.call_depth_two
+> Is leaving  {APPLICATION}.call_depth_one
+</code>
+