[pkg-boost-devel] Bug#687524: libboost1.49-doc: missing examples for program_options ...

[Osamu Aoki]

Hi,

On Sun, Sep 23, 2012 at 09:15:34PM -0500, Steve M. Robbins wrote:
> On Thu, Sep 13, 2012 at 10:14:09PM +0900, Osamu Aoki wrote:
> 
> > I think it will be nice if libboost-defaults makes at least symlink
> >  from "/usr/share/doc/libboost-doc/examples/"
> >  to   "/usr/share/doc/libboost1.49-doc/examples/"
> 
> I made this change.

Thanks.
 
> > and also change text
> >  from "BOOST_ROOT/"
> >  to   "/usr/share/doc/libboost-doc/examples/"
> 
> This is trickier.  There are over 200 instances of BOOST_ROOT in the
> docs.  Instead of patching, I created a README.Debian file to
> explain.  See below.  Let me know if you can improve the wording.
> 
> Thanks,
> -Steve
> 
> 
> 
> 	BOOST_ROOT
> 	----------
> 
> Several places in the documentation and examples refer to the
> top-level directory of the Boost source tree as "BOOST_ROOT".
> Typically, this is used to refer to example code
> ("BOOST_ROOT/libs/program_options/example directory") or to a
> documentation file ("$BOOST_ROOT/doc/html").
> 
> Most such references may be found by looking either in
> /usr/share/doc/libboost-doc/examples or in
> /usr/share/doc/libboost-doc/HTML.  In rare cases, you may need to
> obtain the source tree itself to find the file.
> 
> 
>  -- Steve M. Robbins <smr at debian.org>, Sun, 23 Sep 2012 21:10:55 -0500


I think this is fair. If I were you, I may think about to change the
last paragraph to:

| Most such references may be found by looking either in
| /usr/share/doc/libboost-doc/examples or in
| /usr/share/doc/libboost-doc/HTML.  In rare cases, you may need to
| obtain the source tree itself to find the file.  Please file bug to 
| the libboost-doc package if you find such an exception.

Adding any example files to libboost-doc/examples is quite easy with
debhelper anyway.  Also, this is something upstream should ensure.  So
fixing it via upstream install script is even better.

Osamu