Re: [boost] [filesystem] documentation typo

Subject: Re: [boost] [filesystem] documentation typo
From: Beman Dawes (bdawes_at_[hidden])
Date: 2012-01-26 09:03:30

On Thu, Jan 26, 2012 at 7:09 AM, Greg Rubino <bibil.thaysose_at_[hidden]> wrote:
> Hello,
>
> It looks like there's some copy/paste residue in
>
> http://www.boost.org/doc/libs/1_48_0/libs/filesystem/v3/doc/reference.html#basic_filesystem_error-constructors
>
> basic_filesystem_error has become filesystem_error, but in the anchor
> it's still called 'basic_filesystem_error', and also there are a
> couple of references on the page to basic_filesystem_error.  This
> momentarily confused me when I was moving a codebase from v1 to v3
> yesterday, so I thought it was worth mentioning.
>
> I've entered a trac ticket for this issue:
>
> https://svn.boost.org/trac/boost/ticket/6448

Thanks! That's by far the best way to be sure an issue gets dealt with.

> but I would be delighted to submit a patch for this

I'm in the middle of converting the reference documentation to a
system that generates both the Boost docs and the TR2 proposal from
the same file, so this isn't the best time to submit a patch.

> since I've been
> wanting to get more involved in Boost, but it would be my first time
> doing and I'm not quite sure how to go about it.  I assume that it
> involves checking out the trunk and modifying the necessary files, but
> I'm not sure after that.

Yes, that's the basic procedure. After changing your local checkout of
trunk, generate a patch file (svn or TortoiseSVN make that easy), and
submit it as a ticket.

If the patch is to code, please test first. For filesystem and other
libraries that have a lot of system specific code, it helps to test on
multiple platforms. I'm a Windows developer, and have found VirtualBox
convenient for testing fixes on a Linux virtual machine.

Thanks,

--Beman