Changeset: 153f10e5c2b6 for MonetDB URL: http://dev.monetdb.org/hg/MonetDB?cmd=changeset;node=153f10e5c2b6 Modified Files: clients/iotclient/documentation/iot_server_arguments.rst clients/iotclient/documentation/streams_data_types.rst clients/iotclient/src/main.py Branch: iot Log Message:
Corrections on the documentation diffs (102 lines): diff --git a/clients/iotclient/documentation/iot_server_arguments.rst b/clients/iotclient/documentation/iot_server_arguments.rst --- a/clients/iotclient/documentation/iot_server_arguments.rst +++ b/clients/iotclient/documentation/iot_server_arguments.rst @@ -30,7 +30,7 @@ Set the filesystem directory where the b **-l - -log=** -Location of logfile. On the logfile is reported when streams are created or removed, when tuples are inserted and when the baskets are flushed. By default in UNIX systems is :code:`/var/log/iot/iot.log`, while on Windows is the :code:`iot.log` on the directory where the :code:`main.py` script was invoked. +Location of logfile. On the logfile is reported when streams are created or removed, when tuples are inserted and when the baskets are flushed. By default in UNIX systems is :code:`/var/log/iot/iot.log`, while on Windows is the :code:`iot.log` on the directory where the :code:`main.py` script was called. **-c - -config=** @@ -41,18 +41,18 @@ Host Identifier If the *useidentifier* parameter is provided, an extra column on streams will be added with a custom name of the host for later identification. -**-ui - -useidentifier=** +**-ui - -useidentifier** -Boolean to indicate if the extra column will be added. +Use a host identifier for every new stream. **-in - -name=** -Custom name of the host. By default is the host's MAC address. +Host identifier name. By default is the host's MAC address. Web Server Listening -------------------- -For security purposes, two web servers are created by the application. On the administration server are present operations to create and delete streams, while on application server the insert operations are present instead. The administration server should be listening on the host only, while the application server should be listening to all interfaces. +For security purposes, two web servers are created by the application. On the administration server it's present operations to create and delete streams, while on application server the insert operations are present instead. The administration server should be listening on the host only, while the application server should be listening to all interfaces. **-ih - -ihost=** @@ -64,18 +64,18 @@ Listening port of the application (IOT) **-ah - -ahost=** -Listening host of the administration (IOT) server. By default is on :code:`127.0.0.1`. +Listening host of the administration server. By default is on :code:`127.0.0.1`. **-ap - -aport=** -Listening port of the administration (IOT) server. By default is on port :code:`8001`. +Listening port of the administration server. By default is on port :code:`8001`. Database Connection ------------------- Credentials for the MAPI connection to MonetDB database. -.. note:: The user password will be prompted during the initialization of the server. +.. note:: The user's password will be prompted during the initialization of the server. **-d - -host=** diff --git a/clients/iotclient/documentation/streams_data_types.rst b/clients/iotclient/documentation/streams_data_types.rst --- a/clients/iotclient/documentation/streams_data_types.rst +++ b/clients/iotclient/documentation/streams_data_types.rst @@ -38,7 +38,7 @@ A *Media Access Control Address* identif URL --- -An *Uniform Resource Locator* as a specific type of an URI is validated according to `RFC 3987 <https://www.ietf.org/rfc/rfc3987.txt>`_. The insertion must also be a JSON String. +An *Uniform Resource Locator* as a specific type of an URI is validated according to `RFC 3987 <https://www.ietf.org/rfc/rfc3987.txt>`_. The insertion must be a JSON String. Inet ---- @@ -117,9 +117,9 @@ A regular date in the Gregorian Calendar Time ---- -The time of day expressed in format :code:`HH:MM:SS.sss`. If the pair :code:`"timezone": false` is provided, the timezone will be truncated. +The time of day expressed in format :code:`HH:MM:SS.sss`. If the pair :code:`"timezone": false` is provided, the timezone will be discarded. Timestamp --------- -A timestamp according to `RFC 3339 <https://www.ietf.org/rfc/rfc3339.txt>`_ with timezone. The regular expression is the standard `ISO 8601 with timezone format <https://en.wikipedia.org/wiki/ISO_8601>`_. If the pair :code:`"timezone": false` is provided, the timezone will be truncated. +A timestamp according to `RFC 3339 <https://www.ietf.org/rfc/rfc3339.txt>`_ with timezone. The regular expression is the standard `ISO 8601 with timezone format <https://en.wikipedia.org/wiki/ISO_8601>`_. If the pair :code:`"timezone": false` is provided, the timezone will be discarded. diff --git a/clients/iotclient/src/main.py b/clients/iotclient/src/main.py --- a/clients/iotclient/src/main.py +++ b/clients/iotclient/src/main.py @@ -36,7 +36,7 @@ def main(argv): try: opts, args = getopt.getopt(argv[1:], 'f:l:c:ui:in:ih:ip:ah:ap:h:p:d:u', - ['filesystem=', 'log=', 'config=', 'useidentifier=', 'name=' + ['filesystem=', 'log=', 'config=', 'useidentifier', 'name=' 'ihost=', 'iport=', 'ahost=', 'aport=', 'host=', 'port=', 'database=', 'user=']) except getopt.GetoptError: @@ -66,7 +66,7 @@ def main(argv): elif opt in ('-c', '--config'): new_configfile_location = arg elif opt in ('-ui', '--useidentifier'): - use_host_identifier = bool(arg) + use_host_identifier = True elif opt in ('-in', '--name'): host_identifier = arg _______________________________________________ checkin-list mailing list checkin-list@monetdb.org https://www.monetdb.org/mailman/listinfo/checkin-list
