Browse Source

Doc and comments: some typos & small additions

Matteo Cypriani 4 years ago
parent
commit
4d78da4721
6 changed files with 14 additions and 5 deletions
  1. 3
    0
      COPYRIGHT.t2t
  2. 1
    1
      TODO.t2t
  3. 2
    0
      doc/owlps-deployment.t2t
  4. 4
    1
      doc/owlps.t2t
  5. 2
    1
      libowlps/libowlps.c
  6. 2
    2
      owlps-positioner/cfg/owlps-positioner.conf

+ 3
- 0
COPYRIGHT.t2t View File

@@ -6,6 +6,7 @@ Copyright:
6 6
   2013      Université du Québec en Abitibi-Témiscamingue (Canada)
7 7
   2007-2012 Université de Franche-Comté (France)
8 8
 
9
+
9 10
 The following people contributed writing this software:
10 11
 - //2007-2013// Matteo Cypriani
11 12
 - //2011//      François Spies
@@ -15,8 +16,10 @@ The following people contributed writing this software:
15 16
 - //2008//      Soumaya Zirari
16 17
 - //2007//      Pierre-Frédéric Rossel
17 18
 
19
+
18 20
 Corresponding author: Matteo Cypriani <mcy@lm7.fr>
19 21
 
22
+
20 23
 For a detailed view of each author's contribution, please have a look at
21 24
 the Git history:
22 25
   http://git.lm7.fr/?p=owlps.git

+ 1
- 1
TODO.t2t View File

@@ -8,7 +8,7 @@ Work to do in OwlPS
8 8
 - Known Doxygen problems:
9 9
   - Struct member fields are not documented with INLINE_SIMPLE_STRUCTS
10 10
     http://bugs.debian.org/725122
11
-  - Ugly NAME (new line)
11
+  - Ugly NAME (new line) in libraries' man pages
12 12
     http://bugs.debian.org/630020
13 13
   - Missing spaces around const
14 14
     http://bugs.debian.org/630018

+ 2
- 0
doc/owlps-deployment.t2t View File

@@ -204,6 +204,8 @@ The final ``"$@"`` parameter of the script allows you to call this
204 204
 script with parameters to set additional options or modify the ones you
205 205
 specified in the script.
206 206
 
207
+You can do something similar for OwlPS UDP-to-HTTP.
208
+
207 209
 
208 210
 
209 211
 

+ 4
- 1
doc/owlps.t2t View File

@@ -79,7 +79,7 @@ If you would like to contribute to OwlPS, you can:
79 79
 There is no precise timeline for OwlPS, but the file TODO.t2t lists a
80 80
 bunch of things that should be addressed at some point. A development
81 81
 point release is made after some work has been done, usually mainly on a
82
-particular topic. Usually such a release represents between 30 and 50
82
+particular topic. Usually such a release represents between 30 and 90
83 83
 commits.
84 84
 
85 85
 A stable release is made when a major goal has been reached and the
@@ -156,6 +156,9 @@ formats, etc., are pointed out in the ``CHANGELOG`` file.
156 156
 - Project manager (source code, bug reports, documentation):
157 157
   http://code.lm7.fr/p/owlps/
158 158
 
159
+- Experimentations using OwlPS:
160
+  http://git.lm7.fr/?p=owlps-experiments.git
161
+
159 162
 
160 163
 
161 164
 

+ 2
- 1
libowlps/libowlps.c View File

@@ -45,7 +45,8 @@ bool owl_run = true ;
45 45
  * Converts a MAC address from bytes to character string.
46 46
  * The string is allocated in a static buffer, and will be overwritten
47 47
  * each time this function is called.
48
- * **This function is not thread-safe!**
48
+ * **This function is not thread-safe!** Please use the reentrant version
49
+ * owl_mac_bytes_to_string_r() if concurrent calls are possible.
49 50
  *
50 51
  * @returns A pointer to the static buffer containing the character
51 52
  * string. This pointer must *not* be freed manually by the caller.

+ 2
- 2
owlps-positioner/cfg/owlps-positioner.conf View File

@@ -185,7 +185,7 @@ mobile-csv-file = /usr/local/etc/owlps/mobiles.csv
185 185
 # the path defined here should "link" (include) all the capture points
186 186
 # that are going to be used for this kind of autocalibration.
187 187
 # In the string, the values are separated by semicolons, and each group
188
-# of coordinates can optionnaly be surrounded by parenthesis. The two
188
+# of coordinates can optionally be surrounded by parenthesis. The two
189 189
 # following examples, which declare a path following the points (1;1;1),
190 190
 # (10;1;1) and (10;10;1), are equivalent:
191 191
 #generated-line-path = (1;1;1);(10;1;1);(10;10;1)
@@ -198,7 +198,7 @@ mobile-csv-file = /usr/local/etc/owlps/mobiles.csv
198 198
 
199 199
 # When generate-reference-points includes "list", the list of reference
200 200
 # points declared here is be generated. In the string, the values are
201
-# separated by semicolons, and each group of coordinates can optionnaly
201
+# separated by semicolons, and each group of coordinates can optionally
202 202
 # be surrounded by parenthesis. The two following examples, which
203 203
 # declare the points (1;2;1) and (4;2.5;1), are equivalent:
204 204
 #generated-points-list = (1;2;1);(4;2.5;1)

Loading…
Cancel
Save