[MERGE REVIEW] merge takes --uncommitted

[Martin Pool]

On 14 Aug 2006, John Arbash Meinel <john at arbash-meinel.com> wrote:

> >>> - because this adds a new user-visible feature, I'd like there to be at
> >>>   least a stub in the manual describing it.
> > 
> > Okay, what do you mean by 'the manual'?
> > 
> >>> With those, please merge.
> > 
> > It's already merged, but I'm happy to update it.
> > 
> > Aaron
> 
> I'm pretty sure he means something in doc/*. Either that, or something
> on the Wiki. (maybe something in the man page)?
> 
> I think he is just working from the realization that a lot of our stuff
> isn't officially documented, and is thus difficult to uncover, without
> actually asking questions in IRC or on the mailing list. And that is
> definitely something we need to address.

Yes, that's what I meant.  For now, something towards the end of
tutorial.txt.

I'd like to establish documentation coverage as a habit for people
working on this, and one of the review criteria.  As for tests, it's
probaby much easier to do it when you first write the feature than to
come back and make sure you catch everything later.

We need to think about how the man page should relate to the online help
and to the rst documentation.  man isn't a great way to read large
documents, so I suggest we just keep it more or less as-is with the
command summary, and point people to a separate file.

-- 
Martin