Re: [boost] Attention library authors.. Library requirements testing is now active.

Subject: Re: [boost] Attention library authors.. Library requirements testing is now active.
From: Rene Rivera (grafikrobot_at_[hidden])
Date: 2016-06-15 12:58:27

On Wed, Jun 15, 2016 at 4:03 AM, Andrey Semashev <andrey.semashev_at_[hidden]>
wrote:

> On Wednesday, 15 June 2016 11:52:03 MSK Rene Rivera wrote:
> >
> > 2. Most structure library requirements are now checked both in the
> regular
> > full testing and in the CI testing.
> >
> > I've implemented a script to check for most of the library directory
> > structure and integration requirements. The script runs as an additional
> CI
> > job, currently in Travis. Here's one of those jobs <
> > https://travis-ci.org/boostorg/boost/jobs/137506433>.
>
> In that report:
>
> libs/winapi: error: file not found; Did not find [project-root]/index.html
> file. The file is required for all libraries. Redirection to HTML
> documentation.
> libs/winapi: error: directory not found; Missing [project-root]/doc
> directory.
> The [project-root]/doc directory is required for all libraries. Sources to
> build with and built documentation for the library. If the library needs to
> build documentation from non-HTML files this location must be buildable
> with
> Boost Build.
>
> Boost.WinAPI does not have documentation, it's not a public library. What
> should I do about these errors?
>

I would add a single doc file saying that it's a "private" Boost library.

> libs/winapi: error: file not found; Did not find
> [project-root]/include/boost/
> [library].h* file. A single header for the library is required at [project-
> root]/include/boost/[library].h* if the library does not have a header
> directory at [project-root]/include/boost/[library].
>
> I didn't know this was a requirement. Anyway, there's no single header for
> Boost.WinAPI and its headers are placed under boost/detail/winapi. Again,
> because it's not a public library and because it used to be part of
> Boost.Detail.
>

It's not a requirement. That should be a warning. I'll fix the checker
shortly.

> libs/winapi: error: directory not found; Missing [project-root]/meta
> directory. The [project-root]/meta directory is required for all libraries.
>
> I thought meta/* is supposed to be created by someone else (you?) with a
> pull
> request. I'm not sure what I should do about it.
>

You should create it. In the past Daniel added all of them when they first
introduced. But authors should be adding that file now.

Also there's a python error at the end of the report:
>
> Failed: 'b2' '--debug-configuration' '-j2' '-d0' '--check-libs-only' ERROR
> = 1
>
> # /home/travis/build/boostorg/boost/status> 'b2' '--debug-configuration'
> '-j2'
> '-d0' '--check-libs-only' execution time 9.05490994453 seconds
>
> Traceback (most recent call last):
>

That's just how the CI script works. It throws an exception when a command
fails to avoid continuing on to other commands. When the check errors are
gone that will go away.

-- 
-- Rene Rivera
-- Grafik - Don't Assume Anything
-- Robot Dreams - http://robot-dreams.net
-- rrivera/acm.org (msn) - grafikrobot/aim,yahoo,skype,efnet,gmail