Re: [boost] ATTENTION: Library requirements..

Subject: Re: [boost] ATTENTION: Library requirements..
From: Glen Fernandes (glen.fernandes_at_[hidden])
Date: 2016-01-07 13:30:28

Rene wrote:
> I'm making my Predef library be that "golden" example. By commenting the 
> source to illustrate the requirements. But since my lib doesn't have
> source 
> it may not be the best. 

It's interesting that Boost.Predef has both QBK sources and generated HTML
output in the repository. I was considering doing this for Boost.Align but
did not want repository history affected by commits around generation of
documentation.

Now that we're on git, and each library's repository already has two
branches (master,d develop), maybe it would be a good idea to institute (as
policy) or support (in our infrastructure) a third branch for 
documentation.

1. It serves the users who want to easily view documentation for a given
library's repository. (They can clone that documentation branch).
2. It doesn't require us to put generated documentation output in our main
development branches.
3. It might even allow you support things like: "If <library> has 'docs'
branch, don't require it to have a root level index.html." 

Glen

--
View this message in context: http://boost.2283326.n4.nabble.com/ATTENTION-Library-requirements-tp4682509p4682568.html
Sent from the Boost - Dev mailing list archive at Nabble.com.