diff --git a/.gitignore b/.gitignore index 914e5e2f..694273bd 100644 --- a/.gitignore +++ b/.gitignore @@ -43,3 +43,6 @@ script/ethercatctl script/init.d/ethercat stamp-h1 tool/ethercat +device_drivers.md +generated_table.md +doxygen-output/ diff --git a/Doxyfile.in b/Doxyfile.in index d9f228db..2fab9b99 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -657,7 +657,8 @@ WARN_LOGFILE = INPUT = @top_srcdir@/master \ @top_srcdir@/include \ - @top_srcdir@/devices/ecdev.h + @top_srcdir@/devices/ecdev.h \ + @top_builddir@/device_drivers.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/Makefile.am b/Makefile.am index e08d9322..a8901217 100644 --- a/Makefile.am +++ b/Makefile.am @@ -100,10 +100,16 @@ mrproper: clean cleandoc libtool \ stamp-h1 -doc: +generated_table.md: devices/create_driver_table.py + python3 $< --markdown $@ $(abs_srcdir)/devices + +device_drivers.md: $(srcdir)/devices/device_drivers_template.md generated_table.md + cat $^ > $@ + +doc: device_drivers.md doxygen Doxyfile cleandoc: - @rm -rf doxygen-output + @rm -rf doxygen-output generated_table.md device_drivers.md #----------------------------------------------------------------------------- diff --git a/devices/Makefile.am b/devices/Makefile.am index 4b3931a8..f862e011 100644 --- a/devices/Makefile.am +++ b/devices/Makefile.am @@ -96,6 +96,7 @@ noinst_HEADERS = \ 8139too-5.10-ethercat.c \ 8139too-5.10-orig.c \ create_driver_table.py \ + device_drivers_template.md \ e100-2.6.20-ethercat.c \ e100-2.6.20-orig.c \ e100-2.6.24-ethercat.c \ diff --git a/devices/device_drivers_template.md b/devices/device_drivers_template.md new file mode 100644 index 00000000..c6c3cbb5 --- /dev/null +++ b/devices/device_drivers_template.md @@ -0,0 +1,7 @@ +Device Drivers +============== + +This table contains a list of all available native drivers, +depending on the kernel version. + +The `generic` and the `ccat` driver are independent of the kernel version.