1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
-------------------------------------------------------------------------------
HACKING
-------------------------------------------------------------------------------
Coding style
------------
This project is programmed using the Linux kernel coding style, see
http://lxr.linux.no/linux/Documentation/CodingStyle for details.
Please use the same style for any code contributions, thanks!
The Python decoders should follow the usual Python conventions and use
Python idioms as far as it makes sense. The coding style should mostly follow
the Python PEP-8, which includes the convention of 4 spaces for indentation.
See http://www.python.org/dev/peps/pep-0008/ for details.
Contributions
-------------
- Patches should be sent to the development mailinglist at
sigrok-devel@lists.sourceforge.net (please subscribe to the list first).
https://lists.sourceforge.net/lists/listinfo/sigrok-devel
- Alternatively, you can also clone the git repository and let us know
from where to pull/review your changes. You can use gitorious.org,
github.com, or any other public git hosting site.
Random notes
------------
- Consistently use g_try_malloc() / g_try_malloc0(). Do not use standard
malloc()/calloc() if it can be avoided (sometimes other libs such
as libftdi can return malloc()'d memory, for example).
- Always properly match allocations with the proper *free() functions. If
glib's g_try_malloc()/g_try_malloc0() was used, use g_free() to free the
memory. Otherwise use standard free(). Never use the wrong function!
- Never use g_malloc() or g_malloc0(). These functions do not return NULL
if not enough memory is available but rather lead to an exit() or segfault
instead. This behaviour is not acceptable for libraries.
Use g_try_malloc()/g_try_malloc0() instead and check the return value.
- You should never print any messages (neither to stdout nor stderr nor
elsewhere) "manually" via e.g. printf() or g_log() or similar functions.
Only srd_err()/srd_warn()/srd_info()/srd_dbg()/srd_spew() should be used.
- Use glib's gboolean / TRUE / FALSE for boolean types consistently.
Do not use <stdbool.h> and its true / false, and do not invent private
definitions for this either.
- Consistently use the same naming convention for #include guards in headers:
<PROJECTNAME>_<PATH_TO_FILE>_<FILE>
This ensures that all #include guards are always unique and consistent.
Example: LIBSIGROKDECODE_SIGROKDECODE_INTERNAL_H
- Consistently use the same naming convention for API functions:
<libprefix>_<groupname>_<action>().
Examples:
srd_log_loglevel_set(), srd_log_loglevel_get(), srd_log_handler_set(),
srd_log_handler_set_default(), and so on.
Getter/setter function names should usually end with "_get" or "_set".
Functions creating new "objects" should end with "_new".
Functions destroying "objects" should end with "_destroy".
Functions adding or removing items (e.g. from lists) should end with
either "_add" or "_remove".
Functions operating on all items from a list (not on only one of them),
should end with "_all", e.g. "_remove_all", "_get_all", and so on.
Use "_remove_all" in favor of "_clear" for consistency.
Doxygen
-------
- In Doxygen comments, put an empty line between the block of @param lines
and the final @return line. The @param lines themselves (if there is more
than one) are not separated by empty lines.
- Mark private functions (SRD_PRIV) with /** @private */, so that Doxygen
doesn't include them in the output. Functions that are "static" anyway
don't need to be marked like this.
- Mark private variables/#defines with /** @cond PRIVATE */ and
/** @endcond */, so that Doxygen doesn't include them in the output.
Variables that are "static" don't need to be marked like this.
- Mark all public API functions (SRD_API) with a @since tag which indicates
in which release the respective function was added. If the function has
existed before, but its API changed later, document this as well.
Non-public functions (static ones, and those marked SRD_PRIV) don't need
to have @since markers.
The @since tag should be the last one, i.e. it should come after @param,
@return, @see, and so on.
Examples:
@since 0.1.0
@since 0.1.1 (but the API changed in 0.2.0)
Protocol decoder guidelines
---------------------------
- The 'desc' metadata field for a protocol decoder, which contains a
short, one-line description of the protocol/bus, should be at most 55
characters long, and end with a full stop. This short description can be
displayed on the command-line using "sigrok-cli -V -l 3", or in various
different places in GUIs.
- Longer, multi-line descriptions should be placed in the protocol
decoder's __init__.py file as docstring. It can be viewed (for a specific
protocol decoder, e.g., UART) via "sigrok-cli -a uart", or in various
other places in GUIs.
- Generally use strings for states (of the PD state machine), not integers.
This avoids having to keep a list of state definitions at the top of file.
The performance overhead for this is negligible in practice.
Recommended:
self.state = 'IDLE'
self.state = 'GET STOP BIT'
Not recommended:
self.state = IDLE
self.state = GET_STOP_BIT
(where IDLE = 0 and GET_STOP_BIT = 1, for example)
- Generally use strings for commands/IDs in generated protocol packets.
This avoids having to know magic numbers of the PD in higher-level PDs.
The performance overhead for this is negligible in practice.
Recommended:
self.put(x, y, p, ['STOPBIT', 0, 0])
self.put(x, y, p, ['ADDRESS READ', 0x51])
Not recommended:
self.put(x, y, p, [STOPBIT, 0, 0])
self.put(x, y, p, [ADDRESS_READ, 0x51])
(with STOPBIT = 3 and ADDRESS_READ = 7, for example)
- Use ALL-CAPS names for PD states and protocol packet commands/ID.
Words should be separated by spaces (not underscores or the like).
Recommended:
'FIND ADDRESS', 'GET TEMPERATURE', 'START'
Not recommended:
'FIND_ADDRESS', 'Get Temperature', 'start'
Release engineering
-------------------
See
http://sigrok.org/wiki/Developers/Release_process
for a list of items that need to be done when releasing a new tarball.
|
