Recent changes to Drivers

Drivers modified by Alec Leamas

Alec Leamas — Wed, 14 Jan 2015 23:55:37 -0000

--- v3
+++ v4
@@ -46,6 +46,6 @@
     $ make

 

-[1] http://lirc.sourceforge.net/lirc.org/html/driver-api.html
-[2] https://sourceforge.net/p/lirc/git/ci/master/tree/plugins/
-[3] https://sourceforge.net/p/lirc-remotes/wiki/Checklist/
+[1]: http://lirc.sourceforge.net/lirc.org/html/driver-api.html
+[2]: https://sourceforge.net/p/lirc/git/ci/master/tree/plugins/
+[3]: https://sourceforge.net/p/lirc-remotes/wiki/Checklist/

Drivers modified by Alec Leamas

Alec Leamas — Wed, 14 Jan 2015 23:51:26 -0000

--- v2
+++ v3
@@ -46,6 +46,6 @@
     $ make

 

-[1] http://lirc.sourceforge.net/lirc.org/html/driver-api.htm
+[1] http://lirc.sourceforge.net/lirc.org/html/driver-api.html
 [2] https://sourceforge.net/p/lirc/git/ci/master/tree/plugins/
 [3] https://sourceforge.net/p/lirc-remotes/wiki/Checklist/

Drivers modified by Alec Leamas

Alec Leamas — Wed, 14 Jan 2015 23:49:08 -0000

--- v1
+++ v2
@@ -1,11 +1,18 @@
 ## Adding and removing drivers (0.9.2+)

+### First and foremost
+
+You should have configured your sources. If you are using a distribution tarball, just run ./configure. If you are using the git sources do:
+
+    ./autogen.sh
+    ./configure
+

 ### Removing

-You might want to remove a driver (e. g., build problems) just remove the plugins /.c file.
+If you want to remove a driver (e. g., build problems) just remove the plugins/*.c file.
 if the driver is mentioned in plugins/Makefile.am you need to adjust this file. 

-Also remove the corresponding file in configs and related documentation in 
+Also remove the corresponding file in configs/ and related documentation in 
 doc/html-source/*_driver.html. 

 If the plugin is mentioned in plugins/Makefile.am you need to patch this file.
@@ -14,19 +21,20 @@

 A driver consists of

-  - A source file in plugins/ - see the driver API manual and existing code.
+  - A source file in plugins/ - see the [driver API manual][1] and [existing code][2].
   - A configuration file in configs - see configs/README for format
   - Possibly a documentation file in doc/html-source - see existing
     doc/html-source/*driver.html files. The _driver.html suffix is required.

 When creating a driver for a specific remote,you should also create the lircd.conf for
-this remote. This should should comply to the [checklist](https://sourceforge.net/p/lirc-remotes/wiki/Checklist/). A lirccode driver should always
+this remote. This should should comply to the [checklist][3]. A lirccode driver should always
 submit at least one lircd.conf.

 Besides running tests with your hardware, also check that the new driver can
 be installed using lirc-setup i. e., test also your configs/ file.
 If you need specific build system support (e. g., conditional building and/or linker flags) 
 you need to patch plugins/Makefile.am. In most cases this is not required.
+

 ### Rebuilding

@@ -37,4 +45,7 @@
     $ ./make-pluginlist.sh > pluginlist.am
     $ make

-
+

+[1] http://lirc.sourceforge.net/lirc.org/html/driver-api.htm
+[2] https://sourceforge.net/p/lirc/git/ci/master/tree/plugins/
+[3] https://sourceforge.net/p/lirc-remotes/wiki/Checklist/

Drivers modified by Alec Leamas

Alec Leamas — Fri, 26 Dec 2014 06:37:30 -0000

Adding and removing drivers (0.9.2+)

Removing

You might want to remove a driver (e. g., build problems) just remove the plugins /.c file.
if the driver is mentioned in plugins/Makefile.am you need to adjust this file.

Also remove the corresponding file in configs and related documentation in
doc/html-source/*_driver.html.

If the plugin is mentioned in plugins/Makefile.am you need to patch this file.

Add a driver.

A driver consists of

A source file in plugins/ - see the driver API manual and existing code.
A configuration file in configs - see configs/README for format
Possibly a documentation file in doc/html-source - see existing
doc/html-source/*driver.html files. The _driver.html suffix is required.

When creating a driver for a specific remote,you should also create the lircd.conf for
this remote. This should should comply to the checklist. A lirccode driver should always
submit at least one lircd.conf.

Besides running tests with your hardware, also check that the new driver can
be installed using lirc-setup i. e., test also your configs/ file.
If you need specific build system support (e. g., conditional building and/or linker flags)
you need to patch plugins/Makefile.am. In most cases this is not required.

Rebuilding

After adding or removing a driver and possibly patching plugins/Makefile.am rebuild
using

$ cd plugins
$ ./make-pluginlist.sh > pluginlist.am
$ make