in k, i can generate README of a module like this (from INSTALL):
-generate README file for textops module
make modules=modules/textops modules-readme
when i try it in sip-router, i get:
jh@taimen:/usr/src/orig/sip-router$ rm modules_k/textops/README jh@taimen:/usr/src/orig/sip-router$ make modules=modules_k/textops modules-readme config.mak loaded Makefile.defs defs skipped Makefile:350: "make TLS option is obsoleted, try TLS_HOOKS or CORE_TLS"
config.mak included make[1]: Entering directory `/usr/src/orig/sip-router/modules_k/textops' make[1]: Nothing to be done for `README'. make[1]: Leaving directory `/usr/src/orig/sip-router/modules_k/textops'
i tried 'make man', but it didn't generate textops README either.
-- juha
On Apr 21, 2009 at 19:21, Juha Heinanen jh@tutpro.com wrote:
in k, i can generate README of a module like this (from INSTALL):
-generate README file for textops module
make modules=modules/textops modules-readme
when i try it in sip-router, i get:
jh@taimen:/usr/src/orig/sip-router$ rm modules_k/textops/README jh@taimen:/usr/src/orig/sip-router$ make modules=modules_k/textops modules-readme config.mak loaded Makefile.defs defs skipped Makefile:350: "make TLS option is obsoleted, try TLS_HOOKS or CORE_TLS"
config.mak included make[1]: Entering directory `/usr/src/orig/sip-router/modules_k/textops' make[1]: Nothing to be done for `README'. make[1]: Leaving directory `/usr/src/orig/sip-router/modules_k/textops'
It's ok (and it works for modules_s/textops), but the k modules don't have a Makefile in doc/ => they don't know how to make the README.
So once the doc format clarifies we'll have to add doc/ Makefile to the k modules too (BTW: this means we can have different formats per module, as long as each module has a Makefile under doc/ that knows how to make README, man, html a.s.o.).
cd modules_k/textops; make README will work too.
i tried 'make man', but it didn't generate textops README either.
Right now all ser modules have a simple Makefile under doc/ which includes ../../Makefile.doc. We could create a ../../Makefile.kdoc if needed (I don't know how different are the doc generating parts and whether or not we could reuse the same makefile).
Andrei