From 4d78da4721fff175814b88bc9270273d4a8ff8f6 Mon Sep 17 00:00:00 2001 From: Matteo Cypriani Date: Tue, 18 Feb 2014 10:22:35 -0500 Subject: [PATCH] Doc and comments: some typos & small additions --- COPYRIGHT.t2t | 3 +++ TODO.t2t | 2 +- doc/owlps-deployment.t2t | 2 ++ doc/owlps.t2t | 5 ++++- libowlps/libowlps.c | 3 ++- owlps-positioner/cfg/owlps-positioner.conf | 4 ++-- 6 files changed, 14 insertions(+), 5 deletions(-) diff --git a/COPYRIGHT.t2t b/COPYRIGHT.t2t index 404b917..e91e7c2 100644 --- a/COPYRIGHT.t2t +++ b/COPYRIGHT.t2t @@ -6,6 +6,7 @@ Copyright: 2013 Université du Québec en Abitibi-Témiscamingue (Canada) 2007-2012 Université de Franche-Comté (France) + The following people contributed writing this software: - //2007-2013// Matteo Cypriani - //2011// François Spies @@ -15,8 +16,10 @@ The following people contributed writing this software: - //2008// Soumaya Zirari - //2007// Pierre-Frédéric Rossel + Corresponding author: Matteo Cypriani + For a detailed view of each author's contribution, please have a look at the Git history: http://git.lm7.fr/?p=owlps.git diff --git a/TODO.t2t b/TODO.t2t index 07782bd..47f8a52 100644 --- a/TODO.t2t +++ b/TODO.t2t @@ -8,7 +8,7 @@ Work to do in OwlPS - Known Doxygen problems: - Struct member fields are not documented with INLINE_SIMPLE_STRUCTS http://bugs.debian.org/725122 - - Ugly NAME (new line) + - Ugly NAME (new line) in libraries' man pages http://bugs.debian.org/630020 - Missing spaces around const http://bugs.debian.org/630018 diff --git a/doc/owlps-deployment.t2t b/doc/owlps-deployment.t2t index e817eb5..3101615 100644 --- a/doc/owlps-deployment.t2t +++ b/doc/owlps-deployment.t2t @@ -204,6 +204,8 @@ The final ``"$@"`` parameter of the script allows you to call this script with parameters to set additional options or modify the ones you specified in the script. +You can do something similar for OwlPS UDP-to-HTTP. + diff --git a/doc/owlps.t2t b/doc/owlps.t2t index 83b3393..cb54cc6 100644 --- a/doc/owlps.t2t +++ b/doc/owlps.t2t @@ -79,7 +79,7 @@ If you would like to contribute to OwlPS, you can: There is no precise timeline for OwlPS, but the file TODO.t2t lists a bunch of things that should be addressed at some point. A development point release is made after some work has been done, usually mainly on a -particular topic. Usually such a release represents between 30 and 50 +particular topic. Usually such a release represents between 30 and 90 commits. 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. - Project manager (source code, bug reports, documentation): http://code.lm7.fr/p/owlps/ +- Experimentations using OwlPS: + http://git.lm7.fr/?p=owlps-experiments.git + diff --git a/libowlps/libowlps.c b/libowlps/libowlps.c index a589ba2..02c0835 100644 --- a/libowlps/libowlps.c +++ b/libowlps/libowlps.c @@ -45,7 +45,8 @@ bool owl_run = true ; * Converts a MAC address from bytes to character string. * The string is allocated in a static buffer, and will be overwritten * each time this function is called. - * **This function is not thread-safe!** + * **This function is not thread-safe!** Please use the reentrant version + * owl_mac_bytes_to_string_r() if concurrent calls are possible. * * @returns A pointer to the static buffer containing the character * string. This pointer must *not* be freed manually by the caller. diff --git a/owlps-positioner/cfg/owlps-positioner.conf b/owlps-positioner/cfg/owlps-positioner.conf index 090ac8a..8d2a2c2 100644 --- a/owlps-positioner/cfg/owlps-positioner.conf +++ b/owlps-positioner/cfg/owlps-positioner.conf @@ -185,7 +185,7 @@ mobile-csv-file = /usr/local/etc/owlps/mobiles.csv # the path defined here should "link" (include) all the capture points # that are going to be used for this kind of autocalibration. # In the string, the values are separated by semicolons, and each group -# of coordinates can optionnaly be surrounded by parenthesis. The two +# of coordinates can optionally be surrounded by parenthesis. The two # following examples, which declare a path following the points (1;1;1), # (10;1;1) and (10;10;1), are equivalent: #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 # When generate-reference-points includes "list", the list of reference # points declared here is be generated. In the string, the values are -# separated by semicolons, and each group of coordinates can optionnaly +# separated by semicolons, and each group of coordinates can optionally # be surrounded by parenthesis. The two following examples, which # declare the points (1;2;1) and (4;2.5;1), are equivalent: #generated-points-list = (1;2;1);(4;2.5;1)