awesome

Welcome to awesome bug tracking system.
Tasklist

FS#823 - Recent commit causes 'make' failure.

Attached to Project: awesome
Opened by Cody Carey (codycarey) - Saturday, 18 September 2010, 20:15 GMT
Last edited by Uli Schlachter (psychon) - Tuesday, 28 September 2010, 09:12 GMT
Task Type Bug Report
Category Core
Status Closed
Assigned To No-one
Operating System Linux
Severity High
Priority Normal
Reported Version git/master
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

Commit: 8701295e6c92b632b98fcf6d80857e228c61efd5
"Track the number of objects"

This commit seems to introduce a bug which causes 'make' to fail on Linux. The failure appears to happen when luadoc attempts to read the "@class function" line to generate the documentation about 'instances' from the luadoc/*.lua files.

Below is the output of the following commands:

cmake -DCMAKE_INSTALL_PREFIX=/usr -DSYSCONFDIR=/etc
make

Output:

[ 60%] Built target generated_icons
Scanning dependencies of target luadoc
lua: /usr/share/lua/5.1/luadoc/doclet/html/module.lp:53: bad argument #1 to 'concat' (table expected, got nil)
stack traceback:
[C]: in function 'concat'
/usr/share/lua/5.1/luadoc/doclet/html/module.lp:53: in function 'prog'
/usr/share/lua/5.1/luadoc/lp.lua:129: in function </usr/share/lua/5.1/luadoc/lp.lua:117>
(tail call): ?
/usr/share/lua/5.1/luadoc/doclet/html.lua:241: in function 'start'
/usr/share/lua/5.1/luadoc/init.lua:49: in function </usr/share/lua/5.1/luadoc/init.lua:26>
(tail call): ?
/usr/bin/luadoc:121: in main chunk
[C]: ?
make[2]: *** [CMakeFiles/luadoc] Error 1
make[1]: *** [CMakeFiles/luadoc.dir/all] Error 2
make: *** [all] Error 2
Aborting...
[cody@tritium awesome-git]$

For reference this is on Arch Linux x86_64 with a completely up-to-date system. The previous commit c368b848176d3201f4763101de0de544fa7be7b5 compiles and runs just fine. Let me know what I can do to help.
This task depends upon

Closed by  Uli Schlachter (psychon)
Tuesday, 28 September 2010, 09:12 GMT
Reason for closing:  Fixed
Additional comments about closing:  commit 787bdbe4684340407ce7b36c51005405f9ab620f
Author: Uli Schlachter <psychon@znc.in>
Date: Tue Sep 28 11:12:02 2010 +0200

Work around for luadoc bugs

Signed-off-by: Uli Schlachter <psychon@znc.in
Comment by Uli Schlachter (psychon) - Monday, 27 September 2010, 09:47 GMT
I didn't have luadoc installed so I never actually tried generating the docs.

Anyway, this seems to be a luadoc problem to me. This happens on any function that got no parameters:

$ cat test.lua
--- Foo
-- @name bar
-- @class function
$ luadoc test.lua
lua5.1: /usr/share/lua/5.1/luadoc/doclet/html/file.lp:55: bad argument #1 to 'concat' (table expected, got nil)
stack traceback:
[C]: in function 'concat'
/usr/share/lua/5.1/luadoc/doclet/html/file.lp:55: in function 'prog'
/usr/share/lua/5.1/luadoc/lp.lua:129: in function </usr/share/lua/5.1/luadoc/lp.lua:117>
(tail call): ?
/usr/share/lua/5.1/luadoc/doclet/html.lua:257: in function 'start'
/usr/share/lua/5.1/luadoc/init.lua:49: in function </usr/share/lua/5.1/luadoc/init.lua:26>
(tail call): ?
/usr/bin/luadoc:121: in main chunk
[C]: ?
$ echo '-- @param foobar' >> test.lua
$ luadoc test.lua
$
Comment by Cody Carey (codycarey) - Monday, 27 September 2010, 21:04 GMT
The current solution is to simply instruct cmake to ignore luadoc with '-DGENERATE_LUADOC=false'.

I'd file an upstream bug report but LuaDoc doesn't appear to be actively developed anymore. As you pointed out an alternative solution if you need the docs is to add in dummy parameters. I guess my question is how will the Awesome devs handle this since the upstream problem is unlikely to ever be fixed?

Loading...