This is the mail archive of the libstdc++@gcc.gnu.org mailing list for the libstdc++ project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

manual patch


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:
- bitset.html: I remove a 'recent' word that is not in sync with the 1999 year of the referenced article
- associative.html: The doc was talking about an associative container entry at end(), there is no entry 'at' end() so I replace with 'before' end()
- locales.html: I only fix a useless 'is' word but IMO the German reference could be remove too, numpunct gives the thousand separator for any locale not only the German one.
- bk01pt08ch19.html: The answer to the question about the overhead of vector iterator not being pointer is simply 'Very little'. I was rather frustrated by such an answer. Very little is not none so the answer should contain what this very little is. I added 'limited to compilation process', am I right ? We could even add that there is no runtime overhead to be very clear as it is what users might be afraid of.


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

Bests
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
 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
Index: libstdc++-v3/doc/html/manual/bitset.html
===================================================================
--- libstdc++-v3/doc/html/manual/bitset.html	(révision 156047)
+++ libstdc++-v3/doc/html/manual/bitset.html	(copie de travail)
@@ -49,7 +49,7 @@
      that space savings.
    </p><p>
      The problem is that <code class="code">vector&lt;bool&gt;</code> doesn't
-     behave like a normal vector anymore.  There have been recent
+     behave like a normal vector anymore.  There have been
      journal articles which discuss the problems (the ones by Herb
      Sutter in the May and July/August 1999 issues of C++ Report cover
      it well).  Future revisions of the ISO C++ Standard will change
Index: libstdc++-v3/doc/html/manual/appendix_contributing.html
===================================================================
--- libstdc++-v3/doc/html/manual/appendix_contributing.html	(révision 156047)
+++ libstdc++-v3/doc/html/manual/appendix_contributing.html	(copie de travail)
@@ -87,7 +87,7 @@
 	  implementation. 
 	</p></li><li class="listitem"><p> 
 	  A ChangeLog entry as plain text; see the various
-	  ChangeLog files for format and content. If using you are
+	  ChangeLog files for format and content. If you are
 	  using emacs as your editor, simply position the insertion
 	  point at the beginning of your change and hit CX-4a to bring
 	  up the appropriate ChangeLog entry. See--magic! Similar
Index: libstdc++-v3/doc/html/manual/associative.html
===================================================================
--- libstdc++-v3/doc/html/manual/associative.html	(révision 156047)
+++ libstdc++-v3/doc/html/manual/associative.html	(copie de travail)
@@ -48,7 +48,7 @@
 	  <code class="code">end()</code>, then the item being inserted should have
 	  a key greater than all the other keys in the container.  The
 	  item will be inserted at the end of the container, becoming
-	  the new entry at <code class="code">end()</code>.  
+	  the new entry before <code class="code">end()</code>.  
       </p></li><li class="listitem"><p>
 	  neither <code class="code">begin()</code> nor <code class="code">end()</code>, then:
 	  Let <code class="code">h</code> be the entry in the container pointed to
Index: libstdc++-v3/doc/html/manual/locales.html
===================================================================
--- 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.
 </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.)
 </p><p>
 Because C and earlier versions of POSIX fall down so completely,
 portability is an issue.
Index: libstdc++-v3/doc/html/manual/memory.html
===================================================================
--- libstdc++-v3/doc/html/manual/memory.html	(révision 156047)
+++ libstdc++-v3/doc/html/manual/memory.html	(copie de travail)
@@ -52,7 +52,7 @@
 	 aid to locality if an implementation so
 	 desires. <code class="constant">[20.4.1.1]/6</code>
        </p></li></ul></div><p> 
-     Complete details cam be found in the C++ standard, look in
+     Complete details can be found in the C++ standard, look in
      <code class="constant">[20.4 Memory]</code>.
    </p></div><div class="sect2" title="Design Issues"><div class="titlepage"><div><div><h3 class="title"><a id="allocator.design_issues"></a>Design Issues</h3></div></div></div><p>
     The easiest way of fulfilling the requirements is to call
@@ -95,7 +95,7 @@
     <code class="function">abi::__cxa_atexit</code> is not recommended.
   </p></div><div class="sect2" title="Implementation"><div class="titlepage"><div><div><h3 class="title"><a id="allocator.impl"></a>Implementation</h3></div></div></div><div class="sect3" title="Interface Design"><div class="titlepage"><div><div><h4 class="title"><a id="id602298"></a>Interface Design</h4></div></div></div><p>
      The only allocator interface that
-     is support is the standard C++ interface. As such, all STL
+     is supported is the standard C++ interface. As such, all STL
      containers have been adjusted, and all external allocators have
      been modified to support this change.   
    </p><p> 
@@ -127,7 +127,7 @@
        Insertion and erasure in a multi-threaded environment.
        </p><p>
        This test shows the ability of the allocator to reclaim memory
-     on a pre-thread basis, as well as measuring thread contention
+     on a per-thread basis, as well as measuring thread contention
      for memory resources. 
      Test source 
     <a class="ulink" href="http://gcc.gnu.org/viewcvs/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert_erase/associative.cc?view=markup"; target="_top">here</a>.
@@ -285,8 +285,8 @@
    </p><p>The <code class="varname">thr</code> boolean determines whether the
    pool should be manipulated atomically or not.  When
    <code class="varname">thr</code> = <code class="constant">true</code>, the allocator
-   is is thread-safe, while <code class="varname">thr</code> =
-   <code class="constant">false</code>, and is slightly faster but unsafe for
+   is thread-safe, while when <code class="varname">thr</code> =
+   <code class="constant">false</code>, it is slightly faster but unsafe for
    multiple threads.
    </p><p>
      For thread-enabled configurations, the pool is locked with a
Index: libstdc++-v3/doc/html/manual/bk01pt08ch19.html
===================================================================
--- 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
       typedefs, and typedefs are "meta-information" that simply
       tell the compiler some nicknames; they don't create code.  That
       information gets passed down through inheritance, so while the
Index: libstdc++-v3/doc/html/manual/using_headers.html
===================================================================
--- libstdc++-v3/doc/html/manual/using_headers.html	(révision 156047)
+++ libstdc++-v3/doc/html/manual/using_headers.html	(copie de travail)
@@ -60,7 +60,7 @@
 	(&lt;math.h&gt; in this case), the symbols will be available
 	in the global namespace and perhaps in
 	namespace <code class="code">std::</code> (but this is no longer a firm
-	requirement.) One the other hand, including the C++-style
+	requirement.) On the other hand, including the C++-style
 	header (&lt;cmath&gt;) guarantees that the entities will be
 	found in namespace std and perhaps in the global namespace.
       </p><p>
@@ -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.
 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>stdc++.h</p><p>Includes all standard headers. Actual content varies depending on
 language dialect.
 </p></li><li class="listitem"><p>stdtr1c++.h</p><p>Includes all of &lt;stdc++.h&gt;, and adds all the TR1 headers.
Index: libstdc++-v3/doc/html/manual/using_namespaces.html
===================================================================
--- libstdc++-v3/doc/html/manual/using_namespaces.html	(révision 156047)
+++ libstdc++-v3/doc/html/manual/using_namespaces.html	(copie de travail)
@@ -21,7 +21,7 @@
 std::string;</code>) This approach works well for individual source files, but
 should not be used in a global context, like header files.
 	  </p></li><li class="listitem"><p>use a <span class="emphasis"><em>fully
-qualified name</em></span>for each library symbol
+qualified name</em></span> for each library symbol
 (i.e. <code class="code">std::string</code>, <code class="code">std::cout</code>) Always can be
 used, and usually enhanced, by strategic use of typedefs. (In the
 cases where the qualified verbiage becomes unwieldy.)

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]