Development/Voltron

TDF LibreOffice Document Liberation Project Community Blogs Weblate Nextcloud Redmine Ask LibreOffice Donate

• Wiki Home
• Development
• Design
• QA
• Events
• Documentation
• Website
• Localization
• Accessibility
• Marketing
• Diversity
• Wiki Help

• Overview
• Reporting Bugs
• How to build
• Code Overview
• Git Commands
• Debugging
• EasyHacks
• Release Plan
• FAQ
• Developers
• Extensions
• → Open Issues

Voltron is an extensible debugger UI toolkit written in Python. When used with tmux, it allows for a quite decent text-based debugger.

To install on Unix systems, the installation instructions are as follows:

$ git clone https://github.com/snare/voltron
$ cd voltron
$ ./install.sh

Once this is done, setup either lldb or gdb to use it. For lldb, edit the .lldbinit file, with the following line (MacOS examples given):

command script import /Library/Python/2.7/site-packages/voltron/entry.py

For GDB, setup .gdbinit with the follwoing line:

source /Library/Python/2.7/site-packages/voltron/entry.py

Next, install tmuxifier. Once installed, from the command line run:

$ set EDITOR='vim'
$ tmuxifier new voltron

Replace the text with:

# ~/.tmuxifier/voltron.yml

name: voltron
root: ~/lo/core

startup_window: editor
startup_pane: 0

windows:
  - editor:
      layout: 9eec,169x52,0,0[169x16,0,0{84x16,0,0,0,84x16,85,0,3},169x35,0,17,1]
      panes:
        - make CppunitTest_sw_htmlexport CPPUNITTRACE="lldb --"
        - voltron view command 'frame variable' --lexer c
        - voltron view command 'source list -a $rip -c 31' --lexer c

(obviously in this case, you change make CppunitTest_sw_htmlexport CPPUNITTRACE="lldb --" to whatever command you want to debug, and you change root: to wherever the LibreOffice repository is located).

To run tmuxifier, you run:

$ tmuxifier start voltron

Configuration to setup Voltron debugger in tmux