HelpUpdate : rename files

veejay-current/veejay-server/doc/HOWTO.debugging.md

@@ -1,85 +1,86 @@
-#Debugging veejay
-----------------
+# Debugging veejay
 
 Please report any issues here: https://github.com/c0ntrol/veejay/issues
 
+Open a new bug report for each issue, so an effective bugfix workflow will be completed for each issue.
+
+Other details you should heed
+* Make sure your software is up to date. Ideally, test an in-development version (https://github.com/c0ntrol/veejay)
+* Figure out the steps to reproduce a bug:
+** If you have precise steps to reproduce — great! — you're on your way to reporting a useful bug report.
+** If you can reproduce occasionally, but not after following specific steps, you must provide additional information for the bug to be useful.
 
 ## Redirecting veejay's console output
 
 You can run veejay with the -v commandline flag, telling it to be more
 verbosive:
 
-<pre>
+```
 $ veejay -v -n > /tmp/logfile
-</pre>
+```
 
 You can watch the console logging using tail:
 
-<pre>
+```
 $ tail -f /tmp/logfile
-</pre>
+```
 
 ## Network event logging
 
 You can log all network related events to /tmp/veejay.net.log (file
 destination cannot be changed)
 
-<pre>
+```
 $ export VEEJAY_LOG_NET_IO=on
 
 $ veejay -v
-</pre>
+```
 
 ## Crash Recovery
 
 If veejay crahes, it will write your samplelist and edit descision files to
-$HOME/.veejay/recovery.
+`$HOME/.veejay/recovery`.
 
 The recovery files can be loaded with:
 
-<pre>
+```
 $ veejay /path/to/recovery_editlist_p???.edl -l /path/to/recovery_samplelist_p???.sl
-</pre>
-
+```
 
 ## Useful backtraces
 
-
 A useful backtrace not only contains symbols but also lists the linenumber and
 name of the source file
 
 To enable debugging symbols to be build in you must do a clean build and pass
 the --enable-debug flag to configure.
 
-
-<pre>
+```
 $ ./configure --enable-debug
 $ (make clean)
 $ make -j12 && make install
-</pre>
-
+```
 
 You can attach a debugger to veejay, or you can load veejay in the debugger:
 
-<pre>
-$ ps -aef |grep veejay
-$ gdb -p $PID
-</pre>
+```
+$ sudo gdb -p `pidof veejay`
+```
 
-<pre>
+```
 $ gdb /path/to/veejay
 ...
 $ bt
-</pre>
+```
+
+To enable profiling you must do a clean build and pass
+the --enable-profiling flag to configure.
 
 Alternatively, you can use valgrind to look for memory leaks, threading
 problems, etc:
 
-<pre>
-
+```
 $ valgrind --leak-check=yes --leak-resolution=high --log-file=/tmp/valgrind.veejay.log /path/to/veejay -n -v ...
 
 $ valgrind --tool=helgrind /path/to/veejay -n -v
-
-</pre>
-
+```

veejay-current/veejay-server/doc/README.md

@@ -1,7 +1,7 @@
 * [COPYING](./COPYING)
-* [HowtoCompile.txt](./HowtoCompile.txt)
-* [HowToDebugging.txt](./HowToDebugging.txt)
-* Configure external video plugins - [How to Plugins](./HowtoPlugins.md)
+* Extensive information on building veejay software packages [HOW TO compile](./HOWTO.compile.md)
+* Report a bug ? contribute to a better veejay ? [HOW TO debugging](./HOWTO.debugging.md)
+* All you need to configure external video plugins - [HOW TO plugins](./HOWTO.plugins.md)
 * [HowtoUbuntu.txt](./HowtoUbuntu.txt)
 * [HowtoVeejay-PureData.html](./HowtoVeejay-PureData.html)
 * [INSTALL](./INSTALL)