Am 31.01.2014 11:06 schröbte Gary V. Vaughan:
> Hi Philipp,
Hi!
>
> On Jan 31, 2014, at 11:15 AM, Philipp Janda <siffie...@gmx.net> wrote:
>
>> Am 30.01.2014 16:40 schröbte Hisham:
>>> On 30 January 2014 07:30, Gary V. Vaughan <g...@vaughan.pe> wrote:
>>>> Hi Hisham,
>>>>
>>>> In principle, would you accept a pull request if I did the work (though I
>>>> know the internals of LuaRocks almost not at all, so I might need some
>>>> pointers and a bit of help here and there)?
>>>
>>> And will you maintain it afterwards? (IOW, can I ping you if bug
>>> reports about it come up?)
>>
>> Manpages is still my favorite online documentation format (sadly not
>> many scripting languages since perl use it), so I'd be willing to help
>> with that ...
>
> Awesome, thanks :)
>
>>> The way to go about it would be to add an optional flag `--man` to
>>> luarocks/path.lua (like we have with `--bin`) and also, for
>>> consistency, to add knowledge about man pages to luarocks/doc.lua
>>> (though I really don't want to spread logic on finding the `man`
>>> binary all over the place, the way we did it for the web browser. Just
>>> assume you can os.execute("man ...") if cfg.is_platform("unix")
>>> returns true).
>>
>> We would also need `--lr-man` (because Lua 5.2 users can't use the eval
>> trick without messing up their Lua 5.1 paths).
>
> Can you explain that a bit more, please? I'm guessing you want --lr-man
> to output just the additional MANPATH directories so you can wrap that up
> and call it without getting your LUA_PATH and LUA_CPATH trampled?
Exactly. Currently `luarocks path` outputs shell code which sets
LUA_PATH and LUA_CPATH. This is bad news if you already use those
variables for Lua 5.1, but you can specify the commandline flags
`--lr-path`/`--lr-cpath`/`--lr-bin` which only print the additional
paths used by luarocks so that you can update your environment variables
yourself. `--bin` on the other hand prints the shell code to update PATH
in addition to the normal output of `luarocks path`. So to be consistent
we'd need `--man` which would add shell code to update MANPATH to the
normal output of `luarocks path`, and `--lr-man` which only prints the
additional MANPATH components found in the rocks trees.
>
>> I'm not sure about the
>> `luarocks doc` integration, that seems rather complicated ...
>
> I think having the man pages listed as present by `luarocks doc` is
> perfectly adequate already. It's not luarocks' job to analyze whatever
> the rock packager felt would be useful to add to the doc directory and
> figure out how to display it, IMHO.
Just listing available man-pages seems doable. Figuring out which
man-page to display for `luarocks doc some-rock` is what's bothering me ...
>
> Cheers,
>
Philipp
------------------------------------------------------------------------------
WatchGuard Dimension instantly turns raw network data into actionable
security intelligence. It gives you real-time visual feedback on key
security issues and trends. Skip the complicated setup - simply import
a virtual appliance and go from zero to informed in seconds.
http://pubads.g.doubleclick.net/gampad/clk?id=123612991&iu=/4140/ostg.clktrk
_______________________________________________
Luarocks-developers mailing list
Luarocks-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/luarocks-developers
