Skip to content

Commit

Permalink
copy editing
Browse files Browse the repository at this point in the history
  • Loading branch information
markhamstra committed May 3, 2012
1 parent 1753f9a commit 53a3f36
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions helium/features/logging.rst
@@ -1,31 +1,29 @@
Logging Logging
======= =======


Logging isn't likely to be the most wanted feature, and we actually hope you won't even need to know about it. Logging isn't likely to be the most wanted feature, and we hope that you won't ever need to know about it.
Though, software can crash, and decent logging can go a long way into understanding the reasons behind a failure. But software can crash, and decent logging can go a long way into understanding the reasons behind a failure.
Thus, we have improved the logging infrastructure so that it can be easily controlled by you. In this page we Thus, we have improved the logging infrastructure so that it can be easily controlled by you.
discuss how you can manage logging in the Scala IDE.
In this page we discuss how you can manage logging in the Scala IDE.




Settings Settings
-------- --------


You can access the logging settings in the Eclipse Preferences, click on the ``Scala`` item and select ``Logging``. You can access the logging settings in the Eclipse Preferences. Click on the ``Scala`` item and select ``Logging``.
You should see the following page: You should see the following page:


.. image:: ../images/logging-preferences.jpg .. image:: ../images/logging-preferences.jpg


By default, the log level is set to ``WARN``. That should be enough for the general uses and it should still provide By default, the log level is set to ``WARN``. That should be enough for general use, and it should still provide
some useful information in the event of an error. Naturally, you are free to change the log level at any time (though, some useful information in the event of an error. Naturally, you are free to change the log level at any time -- remember, though, that increasing logging may noticeably decrease performance.
remember that increasing logging may have an observable performance penalty).


All logging information are stored in a ``scala-ide.log`` file located in the ``${workspace}\.metadata\.plugins\org.scala-ide.sdt.core\`` All logging information is stored in a ``scala-ide.log`` file located in the ``${workspace}/.metadata/.plugins/org.scala-ide.sdt.core/``
directory, where ``${workspace}`` is the directory provided when starting up Eclipse, i.e., your Eclipse workspace. This file can grow up directory, where ``${workspace}`` is the directory provided when starting up Eclipse -- i.e., your Eclipse workspace. This file can grow up
to 10MB and it automatically rolls over once the limit is reached. At any time, you can easily check the log's content by clicking on the link located to 10MB, at which point it automatically rolls over. You can easily check the log's contents at any time by clicking on the link at the bottom of the ``Logging`` preferences page.
at the bottom of the page.


For convenience, you can also decide to output all log messages directly in the terminal, but mind that you need to start Eclipse from the Should you so desire, you can also output all log messages directly to the terminal. Be aware that in order to do so you must start Eclipse from the command line. For example, you can start Eclipse from the command line with the following on Mac OSX:
command line to be able to see the log's output. For instance, I can start Eclipse from the command line with the following command (on Mac OSX):


.. code-block:: bash .. code-block:: bash
Expand Down

0 comments on commit 53a3f36

Please sign in to comment.