.bzrmeta/ docs?

[Martin Pool]

On 9 February 2010 11:57, Robert Collins <robertc at robertcollins.net> wrote:
> On Tue, 2010-02-09 at 09:45 +1000, Ian Clatworthy wrote:
>> Robert Collins wrote:
>> > I was looking for docs for bzrmeta while disconnected - I can't see any
>> > within the tree. Is this right?
>>
>> Probably. I don't recall adding anything into the tree. The only formal
>> doc I know of wrt .bzrmeta is
>> http://doc.bazaar.canonical.com/plugins/en/plugin-development.html#managing-data
>
> Those docs make me a little sad: they overlap with
> http://doc.bazaar.canonical.com/bzr.dev/developers/plugin-api.html and
> they aren't part of the core tree.

+1, there seem to be several different things in that guide

1- A list of available popular plugins, their features, sample use,
portability, etc.  For example
<http://doc.bazaar.canonical.com/plugins/en/launchpad-plugin.html> I
think it's fine to have this outside of the bzr tree because it can
evolve independently of bzr releases.  That's what I thought the guide
was going to be.

2- How to install a plugin
<http://doc.bazaar.canonical.com/plugins/en/plugin-installation.html>.
  This is a core feature; I think it should be in the core docs and
pointed to by the first part.

3- How to write a plugin
<http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>.
Again it should be in the core docs so that it has more chance of
being up to date, and it very obviously will evolve as bzrlib evolves.

The split of #3 vs the developer docs already in the tree is a bit
complex; some of them will be relevant to plugin authors (how
transports work) and some fairly irrelevant.  It's probably best to
put them in together and have a clear entry point.

> Is there any chance we can include them in the core tree please?
> (and .bzrmeta docs too at the same time). Or can we please do something
> so that developers and users know _all_ the things they need when
> offline, to be able to read-up on policy, code and reference material.
> (Which reminds me, we don't document testtools in INSTALL: I shall add
> that tomorrow).

It should also have been in testing.txt but I just added it (or at
least I have a branch to do that.)

-- 
Martin <http://launchpad.net/~mbp/>