From 8593ac85fddb2aae581476d8740e970b1a3f56e6 Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Sat, 29 Nov 2014 10:57:23 +0800 Subject: [PATCH] doc/manual/writing_a_driver: use underscore in filenames --- doc/manual/writing_a_driver.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/manual/writing_a_driver.rst b/doc/manual/writing_a_driver.rst index fae02284f..0c62d9e5a 100644 --- a/doc/manual/writing_a_driver.rst +++ b/doc/manual/writing_a_driver.rst @@ -32,13 +32,13 @@ The parameters ``::1`` and 7777 are respectively the address to bind the server #!/usr/bin/env python3 -at the beginning of the file, save it to ``hello-controller.py`` and set its execution permissions: :: +at the beginning of the file, save it to ``hello_controller.py`` and set its execution permissions: :: - $ chmod 755 hello-controller.py + $ chmod 755 hello_controller.py Run it as: :: - $ ./hello-controller.py + $ ./hello_controller.py and verify that you can connect to the TCP port: :: @@ -59,7 +59,7 @@ The client Controller clients are small command-line utilities that expose certain functionalities of the drivers. They are optional, and not used very often - typically for debugging and testing. -Create a ``hello-client.py`` file with the following contents: :: +Create a ``hello_client.py`` file with the following contents: :: #!/usr/bin/env python3 @@ -78,7 +78,7 @@ Create a ``hello-client.py`` file with the following contents: :: Run it as before, while the controller is running. You should see the message appearing on the controller's terminal: :: - $ ./hello-controller.py + $ ./hello_controller.py message: Hello World! When using the driver in an experiment, for simple cases the ``Client`` instance can be returned by the :class:`artiq.language.core.AutoContext` mechanism and used normally as a device.