On 11/11/2014 04:07 AM, Spooge wrote:
On 11/11/2014 09:04 AM, David Roundy wrote:
However, the biggest problem with the lua mode is the lack of documentation.
Would you please elaborate on where you feel the Lua documentation is lacking? I'd like to improve it, and input from someone who has some distance from the software would be greatly appreciated.

I have few suggestion for tup-lua documentation, actually for tup-lua examples.

Maybe it's my personal preference, but in my project I use tup.rule() exclusively, and when working with examples from the website I wasted some time trying to make tup.definerule() do the right thing (; tup.rule() is a bit more powerful - it properly expands variables and tup %-flags, it's also a bit more compact. I don't even use tup.foreach_rule(), as a lua loop works better.

Another thing would be to show how you can specify flags for the compilation (like CFLAGS etc.) the way it is done in original tup parser, so not "in" the rule, but before that. This way you will have one global Tuprules.lua with you compile(), link(), etc... functions and a few Tupfile.lua files which set required flags and then call these functions on appropriate sources.

Currently the lua examples are some sort of "proof of concept", but the most of them are not very useful as presented (because of using tup.definerule()) - it would be nice if they would show something you can just copy-paste into a real project and use right away - with support for all these flags, definitions, include paths etc. Something in the spirit of the very last examples from this page - http://gittup.org/tup/ex_multiple_directories.html

I've already given a link to my embedded project that uses tup+lua for build description, if anyone else uses that we could try to find some common parts. These can safely be assumed to be the most useful and worth presenting in the examples. I hope it's not only me who uses that (;

BTW - here's another thing to improve in the docs - https://github.com/gittup/tup/issues/207

Regards,
FCh

--
--
tup-users mailing list
email: [email protected]
unsubscribe: [email protected]
options: http://groups.google.com/group/tup-users?hl=en
--- You received this message because you are subscribed to the Google Groups "tup-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/d/optout.

Reply via email to