Bug 267105 - [NEW PORTS] textproc/lua-ldoc: Lua documentation generator, devel/lua-penlight: lua useful module
Summary: [NEW PORTS] textproc/lua-ldoc: Lua documentation generator, devel/lua-penligh...
Status: Open
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Li-Wen Hsu
URL: http://github.com/lunarmodules/LDoc/
Keywords:
Depends on:
Blocks:
 
Reported: 2022-10-15 20:43 UTC by Jonathan Reynolds
Modified: 2023-12-28 10:39 UTC (History)
1 user (show)

See Also:
jreynolds1729: merge-quarterly?

Attachments
lua documentation generator (6.12 KB, text/plain)
2022-10-15 20:43 UTC, Jonathan Reynolds 		no flags Details
lua documentation generator (6.24 KB, text/plain)
2022-10-16 12:42 UTC, Jonathan Reynolds 		no flags Details
modified patch (7.66 KB, patch)
2022-10-22 14:56 UTC, Li-Wen Hsu 		no flags Details | Diff
split into standalone ports (9.49 KB, patch)
2022-10-22 18:45 UTC, Jonathan Reynolds 		no flags Details | Diff
split into standalone ports (9.53 KB, patch)
2022-10-22 19:09 UTC, Jonathan Reynolds 		no flags Details | Diff
Use devel/luafilesystem (12.60 KB, patch)
2022-11-02 21:20 UTC, Jonathan Reynolds 		no flags Details | Diff
Show Obsolete (4) View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Jonathan Reynolds 2022-10-15 20:43:29 UTC 
Created attachment 237360 [details]
lua documentation generator

LDoc is a LuaDoc-compatible documentation generator
which can also process C extension source. 
Markdown may be optionally used to render comments,
as well as integrated readme documentation and
pretty-printed example files.
Comment 1 Jonathan Reynolds 2022-10-16 12:42:07 UTC 
Created attachment 237376 [details]
lua documentation generator

Created shar from $PORTSDIR
Comment 2 Li-Wen Hsu freebsd_committer freebsd_triage 2022-10-22 10:15:38 UTC 
Thanks for porting, if possible, please set your name in https://bugs.freebsd.org/bugzilla/userprefs.cgi?tab=account so we can use that in `git commit --author`.
Comment 3 Jonathan Reynolds 2022-10-22 14:35:45 UTC 
(In reply to Li-Wen Hsu from comment #2)
Sure. It's done.
Comment 4 Li-Wen Hsu freebsd_committer freebsd_triage 2022-10-22 14:56:43 UTC 
Created attachment 237526 [details]
modified patch

Thanks, I've modified the patch a little bit to follow the ports standard. One thing I haven't done and not sure if it can be done is: can the two depended modules, Penlight and LuaFileSystem, be split into standalone ports?
Comment 5 Jonathan Reynolds 2022-10-22 15:31:18 UTC 
Thanks. Yes, they can be split into standalone ports.
I don't know what is best, so I decided to pack them into one port.
Shall I split them?
Comment 6 Li-Wen Hsu freebsd_committer freebsd_triage 2022-10-22 15:44:56 UTC 
(In reply to Jonathan Reynolds from comment #5)
If it is able to be split, please do so, then they can be reused for other ports.

Thanks.
Comment 7 Jonathan Reynolds 2022-10-22 18:45:06 UTC 
Created attachment 237536 [details]
split into standalone ports
Comment 8 Jonathan Reynolds 2022-10-22 19:09:17 UTC 
Created attachment 237537 [details]
split into standalone ports

Sorry for the mess up.
Successfully built x11-wm/awesome docs
Comment 9 Li-Wen Hsu freebsd_committer freebsd_triage 2022-10-22 19:14:26 UTC 
(In reply to Jonathan Reynolds from comment #7)
Thanks, just found that we already have devel/luafilesystem (it might need to be rename to devel/lua-luafilesystem) and we can directly use it.
Comment 10 Jonathan Reynolds 2022-10-23 12:27:37 UTC 
After reviewing devel/luafilesystem/Makefile, I've noticed that the keplerproject points to lunarmodules -> https://github.com/keplerproject/luafilesystem

I've also noticed that he enables flavors. I choose not to because I wanted the wrapper to be as 'ldoc' and not as 'ldoc{FLAVOR}'. But now penlight is it's own port. Should I make it work with flavors while adding a DOCS option?
Comment 11 Jonathan Reynolds 2022-11-02 21:20:45 UTC 
Created attachment 237829 [details]
Use devel/luafilesystem

devel/lua-penlight:
    - add WWW
    - use lua:module
    - add DOCS option

textproc/lua-ldoc:
    - add WWW
    - correct RUN_DEPENDS to package lua-penlight>=1.13.1
    - moved ldoc.in -> do-install