On Nov 4, 2008, at 9:28 AM, Brice Figureau wrote:
>
> On Tue, 2008-11-04 at 09:05 -0600, Luke Kanies wrote:
>>
>>
>>
>> I'd do that.  Just generate docs for what people specify.
>>
>> I'd also probably have puppetdoc accept standard ARGV arguments, and
>> consider those to be normal manifests, which it could then produce
>> output for on stdout.  E.g., you could do:
>>
>>   puppetdoc manifests/site.pp
>>
>> and it would give you docs for just that file,
>
> Yes, that is planned, but that's a complete different thing than the
> current rdoc implementation (although it is simple to have).
> What is still unknown at this stage for this mode is what to output in
> this mode... All comments? Only classes, defines and nodes ? in which
> order (I'm afraid that's not something I can control though) ?

I'd do whatever you'd normally show.

>
>> or, as you say, you
>> could do:
>>
>>   puppetdoc --modulepath <...> --manifest <...>
>>
>> Maybe the --manifest becomes redundant at that point, though.
>
> My idea was:
> puppetdoc --modulepath <module path1> --modulepath <module path2>  
> <path1> <path2>...
>
> path1: contains manifests
> path2: contains manifests too
> modulepath1: contains only a module hierarchy
> modulepath2: contains only a module hierarchy
>
> If path1 or path2 encompass any module specified in modulepath, those
> get treated as module of course. The question that remains is, if  
> path1
> and path2 don't encompass any module path, should I treat those module
> path as information, or should I go and scan also those to produce
> documentation.


I'm not sure I understand the complication; module paths contain  
modules, non-module paths contain normal manifests, right?

-- 
Patriotism is often an arbitrary veneration of real estate above
principles. -- George Jean Nathan
---------------------------------------------------------------------
Luke Kanies | http://reductivelabs.com | http://madstop.com


--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"Puppet Developers" group.
To post to this group, send email to puppet-dev@googlegroups.com
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/puppet-dev?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to