[patch] New libstdc++ docs on testing and library versioning

Sandra Loosemore sandra@codesourcery.com
Mon Aug 8 05:39:00 GMT 2016


On 08/04/2016 06:37 PM, Jonathan Wakely wrote:
> I've been working on some changes to the libstdc++ manual recently.
>
> A lot of the changes are just using DocBook markup with more semantic
> meaning (e.g. <option> or <filename> instead of using <code> for
> everything that should use a monospace font) but there are some
> changes to content too.
>
> I've added a new subsection documenting the steps needed to bump the
> library version when adding new symbols, and rewritten the section on
> writing testcases. The main reason for the latter is to encourage the
> use of { dg-do run { target c++11 } } rather than the { dg-options
> "-std=gnu++11" } approach used until now. I've also started
> documenting the libstdc++-specific dg-require-SUPPORT directives
> available for our tests.
>
> [snip]

I tried to look over this patch and my eyes started glazing over....

I suggest trying to separate the markup changes (possibly multiple 
patches, for different kinds of changes) from the new content.  From my 
perspective, I think formatting cleanups and minor copy-editing can go 
in under the obvious patch rule as long as you are satisfied with the 
way it looks and have self-reviewed the patch to make sure you didn't 
accidentally delete some chunk of text or introduce some other 
unintended change.

The new material should be reviewed by someone knowledgeable enough to 
catch problems with the content.

-Sandra



More information about the Libstdc++ mailing list