Hi Klaus,
the next release of my plugin will have a couple of man pages. I included an 'install-doc' section in the Makefile. But one has to do a 'make install-doc' in the plugins source directory to install them.
What do you think about a 'make install-doc-plugins' in VDR's Makefile like that:
install-doc-plugins: @for i in `ls $(PLUGINDIR)/src | grep -v '[^a-z0-9]'`; do $(MAKE) -C "$(PLUGINDIR)/src/$$i" install-doc; done
BR,
Christian
Christian Wieninger wrote:
Hi Klaus,
the next release of my plugin will have a couple of man pages. I included an 'install-doc' section in the Makefile. But one has to do a 'make install-doc' in the plugins source directory to install them.
What do you think about a 'make install-doc-plugins' in VDR's Makefile like that:
install-doc-plugins: @for i in `ls $(PLUGINDIR)/src | grep -v '[^a-z0-9]'`; do $(MAKE) -C "$(PLUGINDIR)/src/$$i" install-doc; done
I wouldn't mind having that.
However, what if a plugin's Makefile doesn't provide an 'install-doc' target? You might want to make sure this doesn't cause tons of error messages. What we would also need is the appropriate change to the 'newplugin' script.
Klaus
Klaus Schmidinger schrieb:
However, what if a plugin's Makefile doesn't provide an 'install-doc' target? You might want to make sure this doesn't cause tons of error messages. What we would also
how about an additional grep like that? :
install-doc-plugins: @for i in `ls $(PLUGINDIR)/src | grep -v '[^a-z0-9]'`; do\ if grep -q "install-doc:" "$(PLUGINDIR)/src/$$i/Makefile" ; then\ $(MAKE) -i -C "$(PLUGINDIR)/src/$$i" install-doc;\ fi;\ done;
need is the appropriate change to the 'newplugin' script.
I would suggest the following for 'newplugin':
install-doc: @echo No documents to install for $(PACKAGE)
BR,
Christian
Christian Wieninger wrote:
Klaus Schmidinger schrieb:
However, what if a plugin's Makefile doesn't provide an 'install-doc' target? You might want to make sure this doesn't cause tons of error messages. What we would also
how about an additional grep like that? :
install-doc-plugins: @for i in `ls $(PLUGINDIR)/src | grep -v '[^a-z0-9]'`; do\ if grep -q "install-doc:" "$(PLUGINDIR)/src/$$i/Makefile" ; then\ $(MAKE) -i -C "$(PLUGINDIR)/src/$$i" install-doc;\ fi;\ done;
Ok.
need is the appropriate change to the 'newplugin' script.
I would suggest the following for 'newplugin':
install-doc: @echo No documents to install for $(PACKAGE)
If a plugin has nothing to install, it shouldn't generate any output. I guess an empty target with a comment like "add commands to install plugin specific docs" should be sufficient.
Klaus
Klaus Schmidinger wrote:
install-doc-plugins: @for i in `ls $(PLUGINDIR)/src | grep -v '[^a-z0-9]'`; do $(MAKE) -C "$(PLUGINDIR)/src/$$i" install-doc; done
I wouldn't mind having that.
However, what if a plugin's Makefile doesn't provide an 'install-doc' target? You might want to make sure this doesn't cause tons of error messages. What we would also need is the appropriate change to the 'newplugin' script.
We could also handle this similar to the libs: On compile, all plugins can put (or symlink) their man-pages into PLUGINS/man, and the install target copies them from there. That way it would be fully backwards compatible.
Cheers,
Udo
Udo Richter schrieb:
We could also handle this similar to the libs: On compile, all plugins can put (or symlink) their man-pages into PLUGINS/man, and the install target copies them from there. That way it would be fully backwards compatible.
This would limit the plugins documentation to 'man'. With the previous approach the plugin can choose the method (man, txt, html, pdf,...).
BR,
Christian
-
Christian Wieninger -
Klaus Schmidinger -
Udo Richter