Boost logo

Boost-Build :

Subject: Re: [Boost-build] New doc format.
From: Rene Rivera (grafikrobot_at_[hidden])
Date: 2018-01-19 04:57:45


On Thu, Jan 18, 2018 at 7:09 PM, Steven Watanabe via Boost-build <
boost-build_at_[hidden]> wrote:

> AMDG
>
> On 01/14/2018 03:35 PM, Rene Rivera via Boost-build wrote:
> >
> > This is just an initial translation.. And will be followed in the future
> > with more automation, style, additions, rewrites, etc changes. Assuming
> key
> > people are okay with this new set of docs.
> >
>
> One thing that I'm not happy about is the way
> the docs are included in the sources.

Can you explain your unhappiness? As I think having reference documentation
in the sources is preferable for a variety of reasons.

> If we're
> going to have the docs in the jam sources, I think
> it should be integrated with the --help system,
> so it can be viewed from the command line and also
> to fit into the codebase better. I've made some
> initial changes to get --help to output adoc (under
> the assumption that the doc comments are valid
> asciidoc) and it seems feasible.
>

Okay.. Not sure if it's worth the effort. But I'm not against that.

-- 
-- Rene Rivera
-- Grafik - Don't Assume Anything
-- Robot Dreams - http://robot-dreams.net


Boost-Build list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk