fix: updated config name, updated doc

Author: mgxd

doc/users/config_file.rst

@@ -137,8 +137,15 @@ Execution
     schedulers the default is set to 2 seconds.
 
 *xvfb_max_wait*
-    Maximum time (in seconds) to wait for Xvfb to start, if the _redirect_x parameter of an Interface is True.
-
+    Maximum time (in seconds) to wait for Xvfb to start, if the _redirect_x
+    parameter of an Interface is True.
+
+*crashfile_format*
+    This option controls the file type of any crashfile generated. Pklz
+    crashfiles allow interactive debugging and rerunning of nodes, while text
+    crashfiles allow portability across machines and shorter load time.
+    (possible values: ``pklz`` and ``txt``; default value: ``pklz``)
+    
 Example
 ~~~~~~~
 

nipype/pipeline/plugins/base.py

@@ -68,13 +68,13 @@ def report_crash(node, traceback=None, hostname=None):
     if not os.path.exists(crashdir):
         os.makedirs(crashdir)
     crashfile = os.path.join(crashdir, crashfile)
-    if str2bool(node.config['execution']['text_crashfiles']):
+    if node.config['execution']['crashfile_format'].lower() in ['text', 'txt']:
         crashfile += '.txt'
     else:
         crashfile += '.pklz'
     logger.info('Saving crash info to %s' % crashfile)
     logger.info(''.join(traceback))
-    if str2bool(node.config['execution']['text_crashfiles']):
+    if node.config['execution']['crashfile_format'].lower() in ['text', 'txt']:
         crash2txt(crashfile, dict(node=node, traceback=traceback))
     else:
         savepkl(crashfile, dict(node=node, traceback=traceback))

nipype/pipeline/plugins/tests/test_base.py

@@ -27,7 +27,7 @@ def test_report_crash():
             mock_node.config = {
                 'execution' : {
                     'crashdump_dir' : '.',
-                    'text_crashfiles' : 'false',
+                    'crashfile_format' : 'pklz',
                 }
             }
 

nipype/utils/config.py

@@ -55,7 +55,7 @@
 remove_unnecessary_outputs = true
 try_hard_link_datasink = true
 single_thread_matlab = true
-text_crashfiles = false
+crashfile_format = pklz
 stop_on_first_crash = false
 stop_on_first_rerun = false
 use_relative_paths = false