[bitbake-devel] Bitbake Docs - Headsup

[Richard Purdie]

We need to pull together and sort out the various bits of work that have
been done on the bitbake docs file. I know Bill has done some work
there, there is also quite a bit more that needs doing and Scott
Rifenbark has kindly offered to help out with this.

Firstly there is the question of the wmat branch. Whilst I know Bill has
"merged" that with master several times, the history is rather untidy
and isn't something that in my view we want to preserve or add into the
master branch in its current form as its just too confused. It isn't a
straight forward rebase either unfortunately. 

I've spent a while untangling and straightening some of it out and have
pushed an updated version to wmat. I've also pushed the first few of
these to the wmat2 branch.

wmat2 contains the import of the Yocto Docs formatting/ makefile/
structure which Bill imported and I think makes sense to use since Scott
is familiar with it and it will give a consistent look and feel to the
"bookshelf" of manuals related to OE/Bitbake. It also splits the single
xml file into multiple chapters which is more maintainable.

The trouble is just beyond the wmat2 head, the manual is completely re
indented and re line wrapped which makes moving commits either side of
that point difficult. Master does have some changes we want to keep
which don't make it through that point although I did try to keep the
obvious ones in the rebased wmat branch.

>From here, I'm proposing Scott will go through the changes and pick in
things as makes sense from the branch. Process wise, Scott will most
likely send out a summary pull request when he has a batch of changes to
send to the manual. I will aim to read them for technical correctness
and pull as appropriate. Scott is a tech writer, not a developer so I'm
trying to give him some room to do what he needs without a full
developer workflow of full patches to the list etc. He has worked on the
Yocto Project docs in a git repository quite successfully so hopefully
this won't be too much different.

If anyone has any concerns about this, please raise them now as Scott is
itching to fix the manual :)

Cheers,

Richard