As a documentation person I shudder at what Carl proposes.
The documentation on the Web site/wiki should provide more depth than
what is generally supplied as a README with the code or than what is in
the usage statement that gets popped when the command is run.
Of course if you are talking about supplying well done man pages for the
commands that are nicely formatted.... 

> -----Original Message-----
> From: Carl Trieloff [mailto:[EMAIL PROTECTED] 
> Sent: Tuesday, January 30, 2007 1:13 PM
> To: Marnie McCormack
> Cc: [email protected]
> Subject: Re: [jira] Assigned: (QPID-14) document qpid-run
> 
> 
> Marnie,
> 
> Alan had made the point that the wiki should refer to doc 
> that is closer to the code I believe. He had suggested that 
> this type of info should be in readme's and then we can think 
> those directly out of svn onto the wiki. I think this is a 
> better way to go so that down loader's have the info and as 
> committers update these aspects they can update the readme's. 
> The text can still all be on the wiki through svn file views.
> 
> Thoughts?
> Carl.
> 
> Marnie McCormack wrote:
> > I mean doc on cwiki for users to understand the options/allow us to 
> > update qpid-server.bat :-)
> >  
> > M
> >
> >  
> > On 1/30/07, *Carl Trieloff* <[EMAIL PROTECTED] 
> > <mailto:[EMAIL PROTECTED]>> wrote:
> >
> >
> >     I think we can close this, Jim did it .. it now docs 
> from cmd line.
> >
> >     Carl.
> >
> >
> >     Marnie McCormack (JIRA) wrote:
> >     >      [
> >     
> https://issues.apache.org/jira/browse/QPID-14?page=com.atlassi
an.jira.plugin.system.issuetabpanels:all-tabpanel
> >     
> <https://issues.apache.org/jira/browse/QPID-14?page=com.atlass
ian.jira.plugin.system.issuetabpanels:all-tabpanel>
> >     ]
> >     >
> >     > Marnie McCormack reassigned QPID-14:
> >     > ------------------------------------
> >     >
> >     >     Assignee: Marnie McCormack  (was: Carl Trieloff)
> >     >
> >     >
> >     >> document qpid-run
> >     >> -----------------
> >     >>
> >     >>                 Key: QPID-14
> >     >>                 URL: 
> https://issues.apache.org/jira/browse/QPID-14
> >     >>             Project: Qpid
> >     >>          Issue Type: Bug
> >     >>          Components: Java Broker, Java Client
> >     >>            Reporter: Rafael H. Schloming
> >     >>         Assigned To: Marnie McCormack
> >     >>             Fix For: M2
> >     >>
> >     >>
> >     >> document all the special options and environment 
> variables that
> >     qpid-run supports
> >     >>
> >     >
> >     >
> >
> >
> >
> 
> 

Reply via email to