Changeset 2335

Timestamp:

05/10/07 01:20:19 (2 years ago)

Author:

fperez

Message:

Documentation fixes. Closes #151

Files:

• ipython/trunk/doc/ChangeLog (modified) (1 diff)
• ipython/trunk/doc/ipython.1 (modified) (1 diff)
• ipython/trunk/doc/manual_base.lyx (modified) (3 diffs)

ipython/trunk/doc/ChangeLog

@@ +1 @@
+2007-05-10  Fernando Perez  <Fernando.Perez@colorado.edu>
+
+    * ipython.1: update man page and full manual with information
+    about threads (remove outdated warning).  Closes #151.
+
-2007-05-09  Fernando Perez  <Fernando.Perez@colorado.edu>
-

ipython/trunk/doc/ipython.1

@@ -89 +89 @@
-relying on it for regular work.
-.
-.SS A WARNING ABOUT SIGNALS AND THREADS
-When any of the thread systems (GTK, QT or WX) are active, either directly or
-via \-pylab with a threaded backend, it is impossible to interrupt
-long-running Python code via Ctrl\-C.  IPython can not pass the
-KeyboardInterrupt exception (or the underlying SIGINT) across threads, so any
-long-running process started from IPython will run to completion, or will have
-to be killed via an external (OS-based) mechanism.
-.br
-.sp 1
-To the best of my knowledge, this limitation is imposed by the Python
-interpreter itself, and it comes from the difficulty of writing portable
-signal/threaded code.  If any user is an expert on this topic and can suggest
-a better solution, I would love to hear about it.  In the IPython sources,
-look at the Shell.py module, and in particular at the runcode() method.
-.
-.SH REGULAR OPTIONS
-After the above threading options have been given, regular options can follow

ipython/trunk/doc/manual_base.lyx

@@ -8774 +8774 @@
--qthread
-\family default
+, 
+\family typewriter
+-q4thread
+\family default
- and 
-\family typewriter
@@ -8784 +8788 @@
-\end_inset
-
- and WXPython applications
-
+3, Qt4 and WXPython
+applications 
- These GUI toolkits need to control the python main loop of execution, so
- or WXPython applicati
-
+3, Qt4 or WXPyth
+application 
- 
-\end_layout
@@ -8833 +8837 @@
- Please experiment with simple test cases before committing to using this
- combination of Tk and GTK/Qt/WX threading in a production environment.
-\end_layout
-
-\begin_layout Subsection
-Signals and Threads
-\end_layout
-
-\begin_layout Standard
-When any of the thread systems (GTK, Qt or WX) are active, either directly
- or via 
-\family typewriter
--pylab
-\family default
- with a threaded backend, it is impossible to interrupt long-running Python
- code via 
-\family typewriter
-Ctrl-C
-\family default
-.
- IPython can not pass the KeyboardInterrupt exception (or the underlying
- 
-\family typewriter
-SIGINT
-\family default
-) across threads, so any long-running process started from IPython will
- run to completion, or will have to be killed via an external (OS-based)
- mechanism.
-\end_layout
-
-\begin_layout Standard
-To the best of my knowledge, this limitation is imposed by the Python interprete
-r itself, and it comes from the difficulty of writing portable signal/threaded
- code.
- If any user is an expert on this topic and can suggest a better solution,
- I would love to hear about it.
- In the IPython sources, look at the 
-\family typewriter
-Shell.py
-\family default
- module, and in particular at the 
-\family typewriter
-runcode()
-\family default
- method.
- 
-\end_layout
-