Difference between revisions of "Developers"
Jump to navigation
Jump to search
Uwe Hermann (talk | contribs) m (Created page with 'This page contains documentation and resources for aspiring sigrok developers. * Release process') |
Uwe Hermann (talk | contribs) m |
||
| Line 1: | Line 1: | ||
This page contains documentation and resources for aspiring sigrok developers. | This page contains documentation and resources for aspiring sigrok developers. | ||
* [[Developers/Release process|Release process]] | == Source code browser == | ||
* [http://sigrok.org/gitweb/ gitweb] | |||
== Tutorials and API descriptions == | |||
* [http://sigrok.org/api/libsigrok/unstable/index.html libsigrok API] | |||
* [[Protocol decoder HOWTO]] | |||
* [[Protocol decoder API]] | |||
* [[Formats and structures]] | |||
* [[Hardware plugin API]] | |||
* [[Input API]] | |||
* [[Output API]] | |||
== Development guidelines == | |||
Please check the respective sub-project's HACKING file for coding guidelines and development tips. | |||
* [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=HACKING;hb=HEAD libsigrok] | |||
* [http://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blob;f=HACKING;hb=HEAD libsigrokdecode] | |||
* [http://sigrok.org/gitweb/?p=sigrok-cli.git;a=blob;f=HACKING;hb=HEAD sigrok-cli] | |||
* [http://sigrok.org/gitweb/?p=sigrok-qt.git;a=blob;f=HACKING;hb=HEAD sigrok-qt] | |||
* [http://sigrok.org/gitweb/?p=sigrok-gtk.git;a=blob;f=HACKING;hb=HEAD sigrok-gtk] | |||
* [http://sigrok.org/gitweb/?p=pulseview.git;a=blob;f=HACKING;hb=HEAD PulseView] | |||
* [http://sigrok.org/gitweb/?p=sigrok-firmware-fx2lafw.git;a=blob;f=HACKING;hb=HEAD sigrok-firmware-fx2lafw] | |||
== Design pages == | |||
This is a list of pages we use while working through new features or designs. They are working documents, not official API or feature documentation. | |||
* [[New trigger specification]] | |||
* [[GUI design]] | |||
* [[High precision analog]] | |||
== Debugging == | |||
If you would like to see the output of the sr_dbg() or sr_err() functions you can use one of the following [[sigrok-cli]] options: | |||
$ '''export SIGROK_DEBUG=1''' | |||
$ '''sigrok-cli -l 5 ''<options>'' ''' | |||
== Release process == | |||
See [[Developers/Release process|Release process]]. | |||
Revision as of 22:10, 1 November 2012
This page contains documentation and resources for aspiring sigrok developers.
Source code browser
Tutorials and API descriptions
- libsigrok API
- Protocol decoder HOWTO
- Protocol decoder API
- Formats and structures
- Hardware plugin API
- Input API
- Output API
Development guidelines
Please check the respective sub-project's HACKING file for coding guidelines and development tips.
Design pages
This is a list of pages we use while working through new features or designs. They are working documents, not official API or feature documentation.
Debugging
If you would like to see the output of the sr_dbg() or sr_err() functions you can use one of the following sigrok-cli options:
$ export SIGROK_DEBUG=1 $ sigrok-cli -l 5 <options>
Release process
See Release process.