Re: [BBv2] quickbook.jam and boostbook question

From: Joao Abecasis (jpabecasis_at_[hidden])
Date: 2005-01-28 08:43:19

Vladimir Prus wrote:
> Hi Joao,
> 
> 
>>Since I didn't get any answers on my previous post, I hereby reiterate
>>my questions.
> 
> 
> Sorry that it took so long!

No hurries! I was beginning to think maybe this is not exactly a BB
issue... More of a boostbook one. Maybe the documentation list would
have been more appropriate (?).

Anyway I have to say I have been trying out BBv2 and I like what I've seen!

>>I wrote a quickbook toolset to generate boostbook documentation from
>>quickbook sources. The toolset is attached to the original post. I would
>>like to propose the addition of the toolset to BB v2, under the tools
>>directory. Is this ok?

Since no one has objected and since quickbook now lives in the tools
directory I guess that somehow grants me the right to add the toolset to
BB... ;)

>>>boostbook.jam defines the BOOSTBOOK type. However, it's generators
>>>are defined as XML -> <something>. Given this I found 2 ways to make
>>>quickbook work:
>>> a) define generator QUICKBOOK -> XML, which leaves me with the
>>> feeling that the generator is not sufficiently "typed"...
>>>
>>> b) define generators BOOSTBOOK -> DOCBOOK (and BOOSTBOOK -> TESTS)
>>> and QUICKBOOK -> BOOSTBOOK. This seems better, but I shouldn't
>>> be messing with boostbook within the quickbook toolset.
> 
> 
> That's right. I suggest that you take the same approach that doxygen.jam uses: 
> you declare QUICKBOOK -> BOOSTBOOK generator, but do not define any other 
> generator. Instead, you add "import bookbook ; " so that the declaration of 
> BOOSTBOOK type is seen. 

If you look at the toolset I posted initially you'll see that the
"import boostbook ;" call is there, so the BOOSTBOOK type should be
visible. But I don't think that's the issue.

I tried to define only the QUICKBOOK -> BOOSTBOOK generator, figuring BB
would see BOOSTBOOK as an XML type anyway. But, it turns out it doesn't
work that way (attached are the error messages I got trying this approach).

I also took a quick peek at doxygen.jam but it seems to work a bit
differently from what I wanted to do for quickbook. Since quickbook
sources map directly to a single boostbook file, my intent is to have
quickbook files work *as if* they were boostbook files:

boostbook my_docs : source.qbk ;

or (just an alias)

quickbook my_docs : source.qbk ;

QUICKBOOK -> BOOSTBOOK/XML is automatically handled behind the scenes.

>>>Are there other alternatives I am missing? How bad could it be to define
>>>the generator as QUICKBOOK -> XML?
> 
> 
> I don't think that's all that bad. I suggested another variant only because 
> it's consistent with doxygen.jam. 

I can settle for QUICKBOOK -> XML. Anyway, I'll give doxygen.jam a
closer look.

BTW, is there a way for the build process to generate the quickbook
executable once with a single compiler and always use that executable,
regardless of the number of compiler toolsets available?

Thanks for your input!

Best regards,

João

 --------------030706080908050907060808 Content-Type: text/plain;
name="error-log"
Content-Transfer-Encoding: base64
Content-Disposition: inline;
filename="error-log"

e0JCdjItY3ZzfS90b29scy9ib29zdGJvb2suamFtOjMxNDogaW4gb2JqZWN0KGJvb3N0Ym9v
ay1nZW5lcmF0b3IpQDEucnVuCndhcm5pbmc6IHJ1bGVuYW1lICQoYmFzZS10YXJnZXQpLmRl
cGVuZHMgZXhwYW5kcyB0byBlbXB0eSBzdHJpbmcKe0JCdjItY3ZzfS9idWlsZC9nZW5lcmF0
b3JzLmphbTo4Mjk6IGluIHRyeS1vbmUtZ2VuZXJhdG9yLXJlYWxseQp7QkJ2Mi1jdnN9L2J1
aWxkL2dlbmVyYXRvcnMuamFtOjkwODogaW4gdHJ5LW9uZS1nZW5lcmF0b3IKe0JCdjItY3Zz
fS9idWlsZC9nZW5lcmF0b3JzLmphbToxMTQ3OiBpbiBjb25zdHJ1Y3QtcmVhbGx5CntCQnYy
LWN2c30vYnVpbGQvZ2VuZXJhdG9ycy5qYW06MTIyMTogaW4gZ2VuZXJhdG9ycy5jb25zdHJ1
Y3QKe0JCdjItY3ZzfS9idWlsZC90YXJnZXRzLmphbToxMjMyOiBpbiBjb25zdHJ1Y3QKe0JC
djItY3ZzfS9idWlsZC90YXJnZXRzLmphbToxMTE4OiBpbiBvYmplY3QodHlwZWQtdGFyZ2V0
KUAxLmdlbmVyYXRlCntCQnYyLWN2c30vYnVpbGQvdGFyZ2V0cy5qYW06NzUwOiBpbiBnZW5l
cmF0ZS1yZWFsbHkKe0JCdjItY3ZzfS9idWlsZC90YXJnZXRzLmphbTo3MjM6IGluIG9iamVj
dChtYWluLXRhcmdldClAMS5nZW5lcmF0ZQp7QkJ2Mi1jdnN9L2J1aWxkL3RhcmdldHMuamFt
OjI1MjogaW4gb2JqZWN0KHByb2plY3QtdGFyZ2V0KUAyLmdlbmVyYXRlCntCQnYyLWN2c30v
YnVpbGQtc3lzdGVtLmphbToxNjA6IGluIGxvYWQKe0JCdjItY3ZzfS9rZXJuZWwvbW9kdWxl
cy5qYW06MjU5OiBpbiBpbXBvcnQKe0JCdjItY3ZzfS9rZXJuZWwvYm9vdHN0cmFwLmphbTox
MjA6IGluIGJvb3N0LWJ1aWxkCntCQnYyLWN2c30vL2Jvb3N0LWJ1aWxkLmphbToyOiBpbiBt
b2R1bGUgc2NvcGUKe0JCdjItY3ZzfS9idWlsZC9nZW5lcmF0b3JzLmphbTo4Mjk6IGluIHRy
eS1vbmUtZ2VuZXJhdG9yLXJlYWxseQoqKiogYXJndW1lbnQgZXJyb3IKKiBydWxlIG9iamVj
dChnZW5lcmF0b3IpQDUucnVuICggcHJvamVjdCBuYW1lID8gOiBwcm9wZXJ0eS1zZXQgOiBz
b3VyY2VzICsgOiBtdWx0aXBsZSA/ICkKKiBjYWxsZWQgd2l0aDogKCBvYmplY3QocHJvamVj
dC10YXJnZXQpQDIgSFRNTC5tYW5pZmVzdCA6IG9iamVjdChwcm9wZXJ0eS1zZXQpQDggOiAg
OiAgKQoqIG1pc3NpbmcgYXJndW1lbnQgc291cmNlcwp7QkJ2Mi1jdnN9L2J1aWxkL2dlbmVy
YXRvcnMuamFtOjI2MDpzZWUgZGVmaW5pdGlvbiBvZiBydWxlICdydW4nIGJlaW5nIGNhbGxl
ZAp7QkJ2Mi1jdnN9L2J1aWxkL2dlbmVyYXRvcnMuamFtOjkwODogaW4gdHJ5LW9uZS1nZW5l
cmF0b3IKe0JCdjItY3ZzfS9idWlsZC9nZW5lcmF0b3JzLmphbToxMTQ3OiBpbiBjb25zdHJ1
Y3QtcmVhbGx5CntCQnYyLWN2c30vYnVpbGQvZ2VuZXJhdG9ycy5qYW06MTIyMTogaW4gZ2Vu
ZXJhdG9ycy5jb25zdHJ1Y3QKe0JCdjItY3ZzfS90b29scy9ib29zdGJvb2suamFtOjMxNzog
aW4gb2JqZWN0KGJvb3N0Ym9vay1nZW5lcmF0b3IpQDEucnVuCntCQnYyLWN2c30vYnVpbGQv
Z2VuZXJhdG9ycy5qYW06ODI5OiBpbiB0cnktb25lLWdlbmVyYXRvci1yZWFsbHkKe0JCdjIt
Y3ZzfS9idWlsZC9nZW5lcmF0b3JzLmphbTo5MDg6IGluIHRyeS1vbmUtZ2VuZXJhdG9yCntC
QnYyLWN2c30vYnVpbGQvZ2VuZXJhdG9ycy5qYW06MTE0NzogaW4gY29uc3RydWN0LXJlYWxs
eQp7QkJ2Mi1jdnN9L2J1aWxkL2dlbmVyYXRvcnMuamFtOjEyMjE6IGluIGdlbmVyYXRvcnMu
Y29uc3RydWN0CntCQnYyLWN2c30vYnVpbGQvdGFyZ2V0cy5qYW06MTIzMjogaW4gY29uc3Ry
dWN0CntCQnYyLWN2c30vYnVpbGQvdGFyZ2V0cy5qYW06MTExODogaW4gb2JqZWN0KHR5cGVk
LXRhcmdldClAMS5nZW5lcmF0ZQp7QkJ2Mi1jdnN9L2J1aWxkL3RhcmdldHMuamFtOjc1MDog
aW4gZ2VuZXJhdGUtcmVhbGx5CntCQnYyLWN2c30vYnVpbGQvdGFyZ2V0cy5qYW06NzIzOiBp
biBvYmplY3QobWFpbi10YXJnZXQpQDEuZ2VuZXJhdGUKe0JCdjItY3ZzfS9idWlsZC90YXJn
ZXRzLmphbToyNTI6IGluIG9iamVjdChwcm9qZWN0LXRhcmdldClAMi5nZW5lcmF0ZQp7QkJ2
Mi1jdnN9L2J1aWxkLXN5c3RlbS5qYW06MTYwOiBpbiBsb2FkCntCQnYyLWN2c30va2VybmVs
L21vZHVsZXMuamFtOjI1OTogaW4gaW1wb3J0CntCQnYyLWN2c30va2VybmVsL2Jvb3RzdHJh
cC5qYW06MTIwOiBpbiBib29zdC1idWlsZAp7QkJ2Mi1jdnN9Ly9ib29zdC1idWlsZC5qYW06
MjogaW4gbW9kdWxlIHNjb3BlCg==
 --------------030706080908050907060808--