improved debugging function with history output

fmv1992 · fmv1992 · commit fe9c27061d6d · 2017-11-18T21:23:40.000-02:00
diff --git a/debugvimrc.vim b/debugvimrc.vim
@@ -6,6 +6,14 @@
 "
 " Only python-mode will be loaded.
 
+" Disable all persistence between sessions.
+let skip_defaults_vim=1
+" TODO XXX: this nevertheless keeps viminfo enabled. As a workaround the flag
+" '-i NONE' should be added to vim's loading.
+set viminfo=
+set nobackup
+set noswapfile
+
 " Modify vimrc configuration.
 execute('set rtp+='. expand('<sfile>:p:h'))
 set rtp -=$HOME/.vim
@@ -19,3 +27,6 @@ let g:pymode_debug = 1
 if ! (has('win16') || has('win32') || has('win64'))
     set shell=/bin/bash
 endif
+
+" IMPORTANT: Do note that the history of this session is saved on the log file.
+" See the augroup in ./ftplugin/python/pymode.vim file.
diff --git a/doc/pymode.txt b/doc/pymode.txt
@@ -693,13 +693,16 @@ Python-mode doesn't work
 ------------------------
 
 Start python mode with:
-`vim -u <path_to_pymode>/debugvimrc.vim`
-Reproduce the error and submit your python mode debug file. You check its
+`vim -i NONE -u <path_to_pymode>/debugvimrc.vim`
+Reproduce the error and submit your python mode debug file. You can check its
 location with `:messages` for something like:
 `pymode debug msg 1: Starting debug on: 2017-11-18 16:44:13 with file /tmp/pymode_debug_file.txt`
 Please submit the entire content of the file along with a reasoning of why the
 plugin seems broken.
 
+	*Underlined	do check for sensitive information in the file before
+	*Underlined	submitting!
+
 
 Rope completion is very slow                                   *pymode-rope-slow*
 ----------------------------
diff --git a/ftplugin/python/pymode.vim b/ftplugin/python/pymode.vim
@@ -241,9 +241,17 @@ if g:pymode_debug
                       \ . strftime("\%Y-\%m-\%d \%H:\%M:\%S")
                       \ . ' with file ' . &verbosefile)
     " }}}
+    " Redefine folding expression. {{{
     if g:pymode_folding
         setlocal foldexpr=pymode#debug#foldingexpr(v:lnum)
     endif
     call pymode#debug#sysinfo()
+    " }}}
+    " Define auto commands for vim. {{{
+    augroup augroup_save_issue_commands
+        autocmd!
+        autocmd VimLeave *.py | call pymode#debug('Session history:') | silent! history
+    augroup END
+    " }}}
 
-endif
+    endif
diff --git a/readme.md b/readme.md
@@ -103,17 +103,18 @@ Then rebuild **helptags** in vim:
 **filetype-plugin** (`:help filetype-plugin-on`) and **filetype-indent**
 (`:help filetype-indent-on`) must be enabled to use python-mode.
 
-# Troubleshooting
+# Troubleshooting/Debugging
 
 If your python-mode doesn't work:
 
-1. **(From the FAQ)** Start python mode with:  
-    `vim -u <path_to_pymode>/debugvimrc.vim`  
-   Reproduce the error and submit your python mode debug file. You check its
-   location with `:messages` for something like:  
-   `pymode debug msg 1: Starting debug on: 2017-11-18 16:44:13 with file /tmp/pymode_debug_file.txt`.  
-   Please submit the entire content of the file along with a reasoning of why
-   the plugin seems broken.
+**(From the FAQ)** Start python mode with:  
+`vim -i NONE -u <path_to_pymode>/debugvimrc.vim`  
+Reproduce the error and submit your python mode debug file. You can check its
+location with `:messages` for something like:  
+`pymode debug msg 1: Starting debug on: 2017-11-18 16:44:13 with file /tmp/pymode_debug_file.txt`.  
+Please submit the entire content of the file along with a reasoning of why the
+plugin seems broken.
+***Do check for sensitive information in the file before submitting.***
 
 # Frequent problems
 
