Boost logo

Boost :

Subject: Re: [boost] Test build for 1.56 available
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2014-07-08 10:12:48


> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Edward Diener
> Sent: 08 July 2014 14:43
> To: boost_at_[hidden]
> Subject: Re: [boost] Test build for 1.56 available
>
> On 7/8/2014 9:04 AM, Andrey Semashev wrote:
> > On Tuesday 08 July 2014 13:10:19 Paul A. Bristow wrote:
> >>> -----Original Message-----
> >>> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of
> >>> Antony
> >>
> >> Polukhin
> >>
> >>> Sent: 08 July 2014 10:27
> >>> To: boost_at_[hidden] List
> >>> Subject: Re: [boost] Test build for 1.56 available
> >>>
> >>> 2014-07-08 12:44 GMT+04:00 Andrey Semashev
> <andrey.semashev_at_[hidden]>:
> >>>> On Tuesday 08 July 2014 09:58:11 Oliver Kowalke wrote:
> >>>>> 2014-07-08 9:53 GMT+02:00 Antony Polukhin <antoshkka_at_[hidden]>:
> >>>>>> Links to the docs are broken for the following libraries in
> >>>>>> libs/libraries.htm: Algorithm, Align, CompressedPair, Context,
> >>>>>> Core, Coroutine, EnableIf, Functional/factory, Functional/forward
> >>>>>> Log,
> >>>>
> >>>> Odeint,
> >>>>
> >>>>>> Phoenix, Range, Spirit, Swap, TTI, TypeIndex, Units
> >>>>>
> >>>>> does this issue require action on the side of the library authors
> >>>>> (like generating and check-in of html etc.)?
> >>>>
> >>>> No autogenerated files in git, please. I believe these test
> >>>> archives simply don't include all docs (not sure if that was
intentional).
> >>>
> >>> Looks more like missing redirects or infinite loop of redirects.
> >>>
> >>> Andrey is absolutely right about autogenerated files in git. About a
> >>> half of
> >> the
> >>
> >>> archive is consumed by the autogenerated docs.
> >>>
> >>> It would be good to have "./b2 docs" in next release and remove all
> >>> the
> >>
> >> generated
> >>
> >>> docs from git.
> >>
> >> I agree - I've found that any generated items in git make maintenance
> >> disastrously messy.
> >>
> >> But we also need to ensure that the setup of the tools, Quickbook,
> >> Autoindex and Inspect are all automatically built to a 'standard'
> >> location, and in the users path, so that the
> >>
> >> ./b2 docs works slickly for everyone.
> >>
> >> It will of course take quite a long time - hours ? - to regenerate
> >> all the docs :-(
> >
> > Personally, I think distributing pre-built docs as a separate package
> > is a better option. Building docs locally require toolchain that is
> > not distributed or built with Boost, so offering users to build the
> > docs themselves is not quite practical. At the same time, I'm sure
> > most users won't use bre-built docs and just go online, so packaging
> > docs with the sources seems like a waste.
>
> I believe most users will execute the index.html in the top-level directory
and expect
> to be able to view the documentation for any Boost library in which they are
> interested from the Libraries link there. To think that we will distribute
versions of
> Boost without this is foolish IMO.

I'm fine with a (or two - html and pdf) separate docs download too.

(But for library authors, it would be good to streamline the build process.
Links from one library to another ought to work smoothly too.)

Paul

---
Paul A. Bristow
Prizet Farmhouse
Kendal UK LA8 8AB
+44 01539 561830

Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk