Re: [Boost-docs] [Boost-build] How to run inspect as part of a test-suite?

Subject: Re: [Boost-docs] [Boost-build] How to run inspect as part of a test-suite?
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2014-02-12 16:50:03

-----Original Message-----
From: Paul A. Bristow [mailto:pbristow_at_[hidden]] 
Sent: 27 December 2013 11:36
To: 'steven_at_[hidden]'; 'Boost.Build developer's and user's list'
Subject: RE: [Boost-build] How to run inspect as part of a test-suite?

> On 12/26/2013 10:20 AM, Paul A. Bristow wrote:
> >
> > Please give it a try and report any problems. Once it is working 
> > smoothly, I'll post a note to the main list
> letting maintainers know how to use it. Basically, what you do is to update your test Jamfile.v2:
> > * Before anything else, add:
> >
> >      path-constant parent : .. ;  # so that inspect will start in boost-root/libs/timer
> >                                  # when run from another directory, 
> > such as boost-root/status

#  Run inspect tool.
 run /boost/tools/inspect//inspect/<variant>release
  : $(parent) -text -brief # command line
  : # input files
  : <dependency>/boost/filesystem//boost_filesystem
    <test-info>always_show_run_output # requirements
  : inspect # test name
 ;

I think I should wait until I have a new machine running the GIT modular boost version (soon)?

I am not (fairly) fully modularized.  I've added this to my jamfile

path-constant parent : .. ;  # Beman Dawes - so that inspect.exe will start in boost-root/libs/timer
                             # when run from another directory, such as boost-root/status

#  Run inspect tool.
 run /boost/tools/inspect//inspect/<variant>release
  : $(parent) -text -brief # command line
  : # input files
  : <dependency>/boost/filesystem//boost_filesystem
    <test-info>always_show_run_output # requirements
  : inspect # test name
 ;

to rebuild svg_plot (used to create Boost.Math lovely plots of functions and distributions).

After crossing lots of Ts and dotting lots of Is, adding licence and copyrights, or boost-no-inspect,  I have finally got a clean run with no inspection errors.

The log file of a repeat run of the jamfile ends:

Indexing section: Implementation and other notes
Indexing section: To Do List
Indexing section: Acknowledgements
647 Index entries were created.
xslt-xsltproc-dir.windows html\standalone_HTML.manifest
link.hardlink ..\..\..\boost\regex.hpp
Hardlink created for ..\..\..\boost\regex.hpp <<===>> ..\..\regex\include\boost\regex.hpp
... lots more links
link.hardlink ..\..\..\boost\test\prg_exec_monitor.hpp
Hardlink created for ..\..\..\boost\test\prg_exec_monitor.hpp <<===>> ..\..\test\include\boost\test\prg_exec_monitor.hpp
compile-c-c++ ..\..\..\bin.v2\tools\inspect\build\msvc-12.0\release\link-static\inspect.obj
inspect.cpp
compile-c-c++ ..\..\..\bin.v2\tools\inspect\build\msvc-12.0\release\link-static\license_check.obj
...  lots of other inspect.cpp files
compile-c-c++ ..\..\..\bin.v2\libs\filesystem\build\msvc-12.0\debug\windows_file_codecvt.obj
windows_file_codecvt.cpp
compile-c-c++ ..\..\..\bin.v2\libs\system\build\msvc-12.0\debug\error_code.obj
error_code.cpp
msvc.link.dll ..\..\..\bin.v2\libs\system\build\msvc-12.0\debug\boost_system-vc120-gd-1_55.dll
   Creating library ..\..\..\bin.v2\libs\system\build\msvc-12.0\debug\boost_system-vc120-gd-1_55.lib and object ..\..\..\bin.v2\libs\system\build\msvc-12.0\debug\boost_system-vc120-gd-1_55.exp
msvc.manifest.dll ..\..\..\bin.v2\libs\system\build\msvc-12.0\debug\boost_system-vc120-gd-1_55.dll
msvc.link.dll ..\..\..\bin.v2\libs\filesystem\build\msvc-12.0\debug\boost_filesystem-vc120-gd-1_55.dll
   Creating library ..\..\..\bin.v2\libs\filesystem\build\msvc-12.0\debug\boost_filesystem-vc120-gd-1_55.lib and object ..\..\..\bin.v2\libs\filesystem\build\msvc-12.0\debug\boost_filesystem-vc120-gd-1_55.exp
msvc.manifest.dll ..\..\..\bin.v2\libs\filesystem\build\msvc-12.0\debug\boost_filesystem-vc120-gd-1_55.dll
testing.capture-output ..\..\..\bin.v2\libs\svg_plot\doc\inspect.test\msvc-12.0\debug\auto-index-internal-on\auto-index-verbose-on\auto-index-on\inspect.run
        1 file(s) copied.
**passed** ..\..\..\bin.v2\libs\svg_plot\doc\inspect.test\msvc-12.0\debug\auto-index-internal-on\auto-index-verbose-on\auto-index-on\inspect.test
...updated 1925 targets...

So it appears to be building the inspect tool every time?

This seems likely to be slower that running a .bat file called inspect.exe which has already been built and lives in /dist/bin/

Or can we call on inspect.exe directly from their ?

Nonetheless this is a major step forward in encouraging Good Behaviour by library docs editors :-)

Waiting for the errors to appear in the Sinner's List.

Thanks

Paul

---
Paul A. Bristow,
Prizet Farmhouse, Kendal LA8 8AB  UK
[phone]  07714330204
pbristow_at_[hidden]