Re: manual patch

[Jonathan Wakely <jwakely dot gcc at gmail dot com>]

2010/1/20 François Dumont:
> Hi
>
> ? As I plan to work a little bit on the libstdc++ project I first read the
> manual. There are some typo in it so here is the patch. The only noticeable
> modifications are:

Thanks for this, improvements are always welcome, and documentation is
a good place to start poking around in the sources.

> ? I haven't done a ChangeLog entry, does this patch deserve one ?

All patches must have a ChangeLog entry.

The HTML files you have corrected are autogenerated from docbook XML
files under doc/xml/manual so those are the sources that should be
changed.

Some specific comments:

> Index: libstdc++-v3/doc/html/manual/ext_allocators.html
> ===================================================================
> --- libstdc++-v3/doc/html/manual/ext_allocators.html ? ?(révision 156047)
> +++ libstdc++-v3/doc/html/manual/ext_allocators.html ? ?(copie de travail)
> @@ -388,7 +388,7 @@
> ?(516/10) blocks will be returned to the global pool where the
> ?allocating thread may pick them up and reuse them.
> ?</p><p>
> -In order to reduce lock contention (since this requires this bins
> +In order to reduce lock contention (since this requires bins

I think the "this" should be there, but there should be an apostrophe
in "bin's" - there are several places in mt_allocator.ml that say
"this bins" when it should be "this bin's"

> ?mutex to be locked) this operation is also made in chunks of blocks
> ?(just like when chunks of blocks are moved from the global freelist to
> ?a threads freelist mentioned above). The "formula" used can probably


===================================================================
> --- libstdc++-v3/doc/html/manual/locales.html ? (révision 156047)
> +++ libstdc++-v3/doc/html/manual/locales.html ? (copie de travail)
> @@ -18,7 +18,7 @@
> ?</p></blockquote></div><p>
> ?Facets actually implement locale functionality. For instance, a facet
> ?called numpunct is the data objects that can be used to query for the
> -thousands separator is in the German locale.
> +thousands separator in the German locale.

It might be better to say "in a locale" instead, originally it
referred to a specific locale (the German one) but your change makes
it nonspecific.

> ?</p><p>
> ?Literally, a facet is strictly defined:
> ?</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li
> class="listitem"><p>
> @@ -46,7 +46,7 @@
> ?</p></div><div class="sect2" title="Design"><div
> class="titlepage"><div><div><h3 class="title"><a
> id="locales.locale.design"></a>Design</h3></div></div></div><p>
> ?The major design challenge is fitting an object-orientated and
> ?non-global locale design on top of POSIX and other relevant standards,
> -which include the Single Unix (nee X/Open.)
> +which include the Single Unix (see X/Open.)

This is wrong - see http://en.wiktionary.org/wiki/n%C3%A9e - but if
you wanted to you could add the accent.


===================================================================
> --- libstdc++-v3/doc/html/manual/bk01pt08ch19.html ? ? ?(révision 156047)
> +++ libstdc++-v3/doc/html/manual/bk01pt08ch19.html ? ? ?(copie de travail)
> @@ -27,7 +27,7 @@
> ? ? ? things as it would be doing if you had hand-coded it yourself (for
> ? ? ? the 273rd time).
> ? ?</p><p>How much overhead <span class="emphasis"><em>is</em></span> there
> when using an iterator class?
> - ? ? ?Very little. ?Most of the layering classes contain nothing but
> + ? ? ?Very little limited to compilation process. ?Most of the layering
> classes contain nothing but

"Limited to compilation process" doesn't make sense to me.


> @@ -76,7 +76,7 @@
> ?and <code class="code">std::sinl</code>.
> ?</p></div><div class="sect2" title="Precompiled Headers"><div
> class="titlepage"><div><div><h3 class="title"><a
> id="manual.intro.using.headers.pre"></a>Precompiled
> Headers</h3></div></div></div><p>There are three base header files that are
> provided. They can be
> ?used to precompile the standard headers and extensions into binary
> -files that may the be used to speed compiles that use these headers.
> +files that may be used to speed compiles that use these headers.

Should be s/the/then/