* [PATCH v3] libstdc++ xml doc typos
@ 2008-03-24 17:30 Ralf Wildenhues
2008-03-25 16:58 ` Benjamin Kosnik
0 siblings, 1 reply; 5+ messages in thread
From: Ralf Wildenhues @ 2008-03-24 17:30 UTC (permalink / raw)
To: gcc-patches, libstdc++
Tested 'make doc-html-doxygen doc-man-doxygen doc-xml-doxygen'
in $host/libstdc++-v3/doc, is that enough? doc-html and doc-pdf
did not work for me, presumably due to Debian's differently named
xml support files.
Please note that bitmap_allocator changes are a bit more than mere
typos.
OK for trunk? In case I have to commit regenerated files, can somebody
apply the patch for me?
Thanks,
Ralf
libstdc++-v3/ChangeLog:
2008-03-24 Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
* doc/xml/manual/bitmap_allocator.xml: Improve wording a bit.
* doc/xml/authors.xml: Fix typos.
* doc/xml/faq.xml: Likewise.
* doc/xml/manual/abi.xml: Likewise.
* doc/xml/manual/allocator.xml: Likewise.
* doc/xml/manual/appendix_contributing.xml: Likewise.
* doc/xml/manual/backwards_compatibility.xml: Likewise.
* doc/xml/manual/build_hacking.xml: Likewise.
* doc/xml/manual/codecvt.xml: Likewise.
* doc/xml/manual/concurrency.xml: Likewise.
* doc/xml/manual/ctype.xml: Likewise.
* doc/xml/manual/debug_mode.xml: Likewise.
* doc/xml/manual/diagnostics.xml: Likewise.
* doc/xml/manual/evolution.xml: Likewise.
* doc/xml/manual/extensions.xml: Likewise.
* doc/xml/manual/locale.xml: Likewise.
* doc/xml/manual/messages.xml: Likewise.
* doc/xml/manual/parallel_mode.xml: Likewise.
* doc/xml/manual/status_cxx200x.xml: Likewise.
* doc/xml/manual/strings.xml: Likewise.
* doc/xml/manual/support.xml: Likewise.
* doc/xml/manual/test.xml: Likewise.
* doc/xml/manual/using.xml: Likewise.
diff --git a/libstdc++-v3/doc/xml/authors.xml b/libstdc++-v3/doc/xml/authors.xml
index dfcdf24..83795ba 100644
--- a/libstdc++-v3/doc/xml/authors.xml
+++ b/libstdc++-v3/doc/xml/authors.xml
@@ -154,7 +154,7 @@
<authorblurb>
<para>
- Policy Based Datastructures, Associative Containers, Unordered
+ Policy Based Data Structures, Associative Containers, Unordered
Containers.
</para>
</authorblurb>
diff --git a/libstdc++-v3/doc/xml/faq.xml b/libstdc++-v3/doc/xml/faq.xml
index a60bee3..6d1feed 100644
--- a/libstdc++-v3/doc/xml/faq.xml
+++ b/libstdc++-v3/doc/xml/faq.xml
@@ -461,7 +461,7 @@
</qandadiv>
-<!-- Platorm-Specific Issues -->
+<!-- Platform-Specific Issues -->
<qandadiv id="faq.platform-specific" xreflabel="Platform-Specific Issues">
<title>Platform-Specific Issues</title>
@@ -661,7 +661,7 @@
enough to detect when the minimal support to
enable <type>wchar_t</type> and C++ library structures
like <classname>wstring</classname> were present. This impacted Solaris,
- Darwin, and BSD varients, and is fixed in libstdc++ versions post 4.1.0.
+ Darwin, and BSD variants, and is fixed in libstdc++ versions post 4.1.0.
</para>
<para>
</para>
@@ -1098,7 +1098,7 @@
</question>
<answer id="a-extensions_and_backwards_compat">
<para>
- See the <link linkend="manual.appendix.porting.backwards">link</link> on backwards compatiblity and <link linkend="appendix.porting.api">link</link> on evolution.
+ See the <link linkend="manual.appendix.porting.backwards">link</link> on backwards compatibility and <link linkend="appendix.porting.api">link</link> on evolution.
</para>
</answer>
</qandaentry>
@@ -1251,4 +1251,4 @@
</article>
-</book>
\ No newline at end of file
+</book>
diff --git a/libstdc++-v3/doc/xml/manual/abi.xml b/libstdc++-v3/doc/xml/manual/abi.xml
index c11da95..aef1471 100644
--- a/libstdc++-v3/doc/xml/manual/abi.xml
+++ b/libstdc++-v3/doc/xml/manual/abi.xml
@@ -99,7 +99,7 @@ given compiler ABI. In a nutshell:
<para>
To use a specific version of the C++ ABI, one must use a
- corresponding GNU C++ toolchain (Ie, g++ and libstdc++) that
+ corresponding GNU C++ toolchain (i.e., g++ and libstdc++) that
implements the C++ ABI in question.
</para>
@@ -183,7 +183,7 @@ release of the series to remain link compatible.
<para>It is versioned with the following labels and version
definitions, where the version definition is the maximum for a
particular release. Labels are cumulative. If a particular release
- is not listed, it has the same version labels as the preceeding
+ is not listed, it has the same version labels as the preceding
release.</para>
<para>This corresponds to the mapfile: gcc/libgcc-std.ver</para>
@@ -252,7 +252,7 @@ release of the series to remain link compatible.
gcc-3.2.1 release, which has GLIBCPP_3.2.1 for new symbols and
GLIBCPP_3.2 for symbols that were introduced in the gcc-3.2.0
release.) If a particular release is not listed, it has the same
- version labels as the preceeding release.
+ version labels as the preceding release.
</para>
<itemizedlist>
<listitem><para>gcc-3.0.0: (Error, not versioned)</para></listitem>
@@ -737,7 +737,7 @@ class in registers, the compiler will be forced to use memory. See <ulink url="h
<varlistentry>
<term><code>namespace std</code></term>
<listitem><para> Defaults to exporting all symbols in label
-<code>GLIBCXX</code> that do not begin with an underscore, ie
+<code>GLIBCXX</code> that do not begin with an underscore, i.e.,
<code>__test_func</code> would not be exported by default. Select
exceptional symbols are allowed to be visible.</para></listitem>
</varlistentry>
@@ -972,7 +972,7 @@ gcc test.c -g -O2 -L. -lone -ltwo /usr/lib/libstdc++.so.5 /usr/lib/libstdc++.so.
difficult. In particular, compiler generated constructs such as
implicit instantiations for templates, typeinfo information, and
virtual tables all may cause ABI leakage across shared library
- boundaries. Because of this, mixing C++ ABI's is not recommended at
+ boundaries. Because of this, mixing C++ ABIs is not recommended at
this time.
</para>
@@ -1127,4 +1127,4 @@ gcc test.c -g -O2 -L. -lone -ltwo /usr/lib/libstdc++.so.5 /usr/lib/libstdc++.so.
</bibliography>
-</sect1>
\ No newline at end of file
+</sect1>
diff --git a/libstdc++-v3/doc/xml/manual/allocator.xml b/libstdc++-v3/doc/xml/manual/allocator.xml
index 213d82b..cc325be 100644
--- a/libstdc++-v3/doc/xml/manual/allocator.xml
+++ b/libstdc++-v3/doc/xml/manual/allocator.xml
@@ -19,7 +19,7 @@
class template called <classname>allocator</classname>. The
<classname>allocator</classname> abstraction is used throughout the
library in <classname>string</classname>, container classes,
- algorithnms, and parts of iostreams. This class, and base classes of
+ algorithms, and parts of iostreams. This class, and base classes of
it, are the superset of available free store (<quote>heap</quote>)
management classes.
</para>
@@ -261,7 +261,7 @@
directly, for every allocation. (See
<filename>include/ext/new_allocator.h</filename>, for instance.)
However, that option would involve changing source code to use
- the a non-default allocator. Another option is to force the
+ a non-default allocator. Another option is to force the
default allocator to remove caching and pools, and to directly
allocate with every call of <function>allocate</function> and
directly deallocate with every call of
@@ -397,7 +397,7 @@
</para>
<para>
Includes memory tracking and marking abilities as well as hooks for
- throwing exceptinos at configurable intervals (including random,
+ throwing exceptions at configurable intervals (including random,
all, none).
</para>
</listitem>
@@ -447,7 +447,7 @@
<para>The <varname>thr</varname> boolean determines whether the
pool should be manipulated atomically or not. When
<varname>thr</varname> = <constant>true</constant>, the allocator
- is is threadsafe, while <varname>thr</varname> =
+ is is thread-safe, while <varname>thr</varname> =
<constant>false</constant>, and is slightly faster but unsafe for
multiple threads.
</para>
@@ -455,7 +455,7 @@
<para>
For thread-enabled configurations, the pool is locked with a
single big lock. In some situations, this implementation detail
- may result in severe performance degredation.
+ may result in severe performance degradation.
</para>
<para>
diff --git a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
index 543296a..f9edbe1 100644
--- a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
+++ b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
@@ -316,7 +316,7 @@ indicate a place that may require attention for multi-thread safety.
<para>
</para>
<sect2 id="coding_style.bad_identifiers" xreflabel="coding_style.bad">
- <title>Bad Itentifiers</title>
+ <title>Bad Identifiers</title>
<para>
Identifiers that conflict and should be avoided.
</para>
@@ -653,7 +653,7 @@ indicate a place that may require attention for multi-thread safety.
for definitions. For C++, where we have member functions that can
be either inline definitions or declarations, keeping to this
standard allows all member function names for a given class to be
- aligned to the same margin, increasing readibility.
+ aligned to the same margin, increasing readability.
10. Invocation of member functions with "this->"
@@ -679,7 +679,7 @@ indicate a place that may require attention for multi-thread safety.
12. Spacing under protected and private in class declarations:
space above, none below
- ie
+ i.e.
public:
int foo;
@@ -691,7 +691,7 @@ indicate a place that may require attention for multi-thread safety.
13. Spacing WRT return statements.
no extra spacing before returns, no parenthesis
- ie
+ i.e.
}
return __ret;
@@ -708,7 +708,7 @@ indicate a place that may require attention for multi-thread safety.
14. Location of global variables.
- All global variables of class type, whether in the "user visable"
+ All global variables of class type, whether in the "user visible"
space (e.g., cin) or the implementation namespace, must be defined
as a character array with the appropriate alignment and then later
re-initialized to the correct value.
@@ -1055,7 +1055,7 @@ indicate a place that may require attention for multi-thread safety.
<title>Prerequisites</title>
<para>
Editing the DocBook sources requires an XML editor. Many
- exist: some noteable options
+ exist: some notable options
include <command>emacs</command>, <application>Kate</application>,
or <application>Conglomerate</application>.
</para>
@@ -1083,7 +1083,7 @@ indicate a place that may require attention for multi-thread safety.
</para>
<para>
- For procesessing XML, an XML processor and some style
+ For processing XML, an XML processor and some style
sheets are necessary. Defaults are <command>xsltproc</command>
provided by <filename>libxslt</filename>.
</para>
@@ -1163,10 +1163,10 @@ xmllint --noout --valid <filename>xml/index.xml</filename>
faq.xml - index to FAQ
api.xml - index to source level / API
- All *.txml files are template xml files, ie otherwise empty files with
+ All *.txml files are template xml files, i.e., otherwise empty files with
the correct structure, suitable for filling in with new information.
- <emphasis>Cannonical Writing Style</emphasis>
+ <emphasis>Canonical Writing Style</emphasis>
class template
function template
@@ -1496,7 +1496,7 @@ xmllint --noout --valid <filename>xml/index.xml</filename>
"export") is badly needed.
When building a shared library, the current compiler/linker cannot
- automatically generate the instantiatiations needed. This creates a
+ automatically generate the instantiations needed. This creates a
miserable situation; it means any time something is changed in the
library, before a shared library can be built someone must manually
copy the declarations of all templates that are needed by other parts
@@ -2100,7 +2100,7 @@ xmllint --noout --valid <filename>xml/index.xml</filename>
by filebuf. These wrappings have not been completed, though there
is scaffolding in place.
- The encapulation of certain C header <cstdio> names presents an
+ The encapsulation of certain C header <cstdio> names presents an
interesting problem. It is possible to define an inline std::fprintf()
implemented in terms of the 'extern "C"' vfprintf(), but there is no
standard vfscanf() to use to implement std::fscanf(). It appears that
diff --git a/libstdc++-v3/doc/xml/manual/backwards_compatibility.xml b/libstdc++-v3/doc/xml/manual/backwards_compatibility.xml
index 49a0ca8..42a64aa 100644
--- a/libstdc++-v3/doc/xml/manual/backwards_compatibility.xml
+++ b/libstdc++-v3/doc/xml/manual/backwards_compatibility.xml
@@ -148,7 +148,7 @@ considered replaced and rewritten.
then using that to set a value for the <code>NAMESPACE_STD</code>
macro. At that point, one is able to use
<code>NAMESPACE_STD::string</code>, which will evaluate to
- <code>std::string</code> or <code>::string</code> (ie, in the
+ <code>std::string</code> or <code>::string</code> (i.e., in the
global namespace on systems that do not put <code>string</code> in
<code>std::</code>).
</para>
@@ -346,7 +346,7 @@ erase(size_type __pos = 0, size_type __n = npos)
</programlisting>
<para>
- Unfortunately, ut <code>clear</code> is not implemented in this
+ Unfortunately, <code>clear</code> is not implemented in this
version, so you should use <code>erase</code> (which is probably
faster than <code>operator=(charT*)</code>).
</para>
@@ -815,7 +815,7 @@ No <code>stream::attach(int fd)</code>
<para>
For a portable solution (among systems which use
- filedescriptors), you need to implement a subclass of
+ file descriptors), you need to implement a subclass of
<code>std::streambuf</code> (or
<code>std::basic_streambuf<..></code>) which opens a file
given a descriptor, and then pass an instance of this to the
@@ -1312,4 +1312,4 @@ AC_DEFUN([AC_HEADER_UNORDERED_SET], [
</bibliography>
-</sect1>
\ No newline at end of file
+</sect1>
diff --git a/libstdc++-v3/doc/xml/manual/bitmap_allocator.xml b/libstdc++-v3/doc/xml/manual/bitmap_allocator.xml
index e05fc16..1815a39 100644
--- a/libstdc++-v3/doc/xml/manual/bitmap_allocator.xml
+++ b/libstdc++-v3/doc/xml/manual/bitmap_allocator.xml
@@ -240,8 +240,8 @@ else return false.</para></listitem>
</para>
<para>
- Where, k => The constant overhead per node. eg. for list, it is
- 8 bytes, and for map it is 12 bytes. c => The size of the
+ where k is the constant overhead per node (e.g., for list, it is
+ 8 bytes, and for map it is 12 bytes) and c is the size of the
base type on which the map/list is instantiated. Thus, suppose the
type1 is int and type2 is double, they are related by the relation
sizeof(double) == 2*sizeof(int). Thus, all types must have this
@@ -556,4 +556,4 @@ equivalent.</para></listitem>
</sect2>
-</sect1>
\ No newline at end of file
+</sect1>
diff --git a/libstdc++-v3/doc/xml/manual/build_hacking.xml b/libstdc++-v3/doc/xml/manual/build_hacking.xml
index b420f4f..3f47e65 100644
--- a/libstdc++-v3/doc/xml/manual/build_hacking.xml
+++ b/libstdc++-v3/doc/xml/manual/build_hacking.xml
@@ -104,7 +104,7 @@
<para>
Most comments should use {octothorpes, shibboleths, hash marks,
- pound signs, whatevers} rather than "dnl". Nearly all comments in
+ pound signs, whatever} rather than "dnl". Nearly all comments in
configure.ac should. Comments inside macros written in ancilliary
.m4 files should. About the only comments which should
<emphasis>not</emphasis> use #, but use dnl instead, are comments
@@ -351,4 +351,4 @@
</sect2>
-</sect1>
\ No newline at end of file
+</sect1>
diff --git a/libstdc++-v3/doc/xml/manual/codecvt.xml b/libstdc++-v3/doc/xml/manual/codecvt.xml
index 4c14d62..c836f9d 100644
--- a/libstdc++-v3/doc/xml/manual/codecvt.xml
+++ b/libstdc++-v3/doc/xml/manual/codecvt.xml
@@ -190,7 +190,7 @@ UTF-16, UTF8, UTF16).
<para>
For iconv-based implementations, string literals for each of the
-encodings (ie. "UCS-2" and "UTF-8") are necessary,
+encodings (i.e. "UCS-2" and "UTF-8") are necessary,
although for other,
non-iconv implementations a table of enumerated values or some other
mechanism may be required.
@@ -218,7 +218,7 @@ mechanism may be required.
</para></listitem>
<listitem><para>
- Conversion descriptors for both directions of encoding. (ie, both
+ Conversion descriptors for both directions of encoding. (i.e., both
UCS-2 to UTF-8 and UTF-8 to UCS-2.)
</para></listitem>
@@ -301,7 +301,7 @@ codecvt<char, char, mbstate_t>
</code>
</para>
<para>
-This is a degenerate (ie, does nothing) specialization. Implementing
+This is a degenerate (i.e., does nothing) specialization. Implementing
this was a piece of cake.
</para>
@@ -727,4 +727,4 @@ codecvt usage.
</bibliography>
-</sect1>
\ No newline at end of file
+</sect1>
diff --git a/libstdc++-v3/doc/xml/manual/concurrency.xml b/libstdc++-v3/doc/xml/manual/concurrency.xml
index 5740e42..b21d458 100644
--- a/libstdc++-v3/doc/xml/manual/concurrency.xml
+++ b/libstdc++-v3/doc/xml/manual/concurrency.xml
@@ -194,7 +194,7 @@ host hardware and operating system.
<sect1 id="manual.ext.concurrency.impl" xreflabel="Implementation">
<title>Implementation</title>
<sect2 id="manual.ext.concurrency.impl.atomic_fallbacks" xreflabel="Atomic F">
- <title>Using Builitin Atomic Functions</title>
+ <title>Using Builtin Atomic Functions</title>
<para>The functions for atomic operations described above are either
implemented via compiler intrinsics (if the underlying host is
@@ -261,7 +261,7 @@ hardware, hand-crafted assembly is selected. This is the case for the following
<sect2 id="manual.ext.concurrency.impl.thread" xreflabel="Pthread">
<title>Thread Abstraction</title>
-<para>A thin layer above IEEE 1003.1 (ie pthreads) is used to abstract
+<para>A thin layer above IEEE 1003.1 (i.e. pthreads) is used to abstract
the thread interface for GCC. This layer is called "gthread," and is
comprised of one header file that wraps the host's default thread layer with
a POSIX-like interface.
diff --git a/libstdc++-v3/doc/xml/manual/ctype.xml b/libstdc++-v3/doc/xml/manual/ctype.xml
index 8ecd7b9..58f08fb 100644
--- a/libstdc++-v3/doc/xml/manual/ctype.xml
+++ b/libstdc++-v3/doc/xml/manual/ctype.xml
@@ -99,7 +99,7 @@ characters.
<listitem>
<para>
Get the ctype<wchar_t>::mask stuff under control. Need to
- make some kind of static table, and not do lookup evertime
+ make some kind of static table, and not do lookup every time
somebody hits the do_is... functions. Too bad we can't just
redefine mask for ctype<wchar_t>
</para></listitem>
@@ -256,4 +256,4 @@ characters.
</bibliography>
-</sect1>
\ No newline at end of file
+</sect1>
diff --git a/libstdc++-v3/doc/xml/manual/debug_mode.xml b/libstdc++-v3/doc/xml/manual/debug_mode.xml
index e5f3bec..223abcf 100644
--- a/libstdc++-v3/doc/xml/manual/debug_mode.xml
+++ b/libstdc++-v3/doc/xml/manual/debug_mode.xml
@@ -582,7 +582,7 @@ template<typename _Tp, typename _Allocator = allocator<_Tp>
allows release-compiled and debug-compiled code to be linked and
executed together without causing unpredictable behavior. This
guarantee minimizes the recompilation that users are required to
- perform, shortening the detect-compile-debug bughunting cycle
+ perform, shortening the detect-compile-debug bug hunting cycle
and making the debug mode easier to incorporate into development
environments by minimizing dependencies.</para>
diff --git a/libstdc++-v3/doc/xml/manual/diagnostics.xml b/libstdc++-v3/doc/xml/manual/diagnostics.xml
index f43614c..bb6ef4d 100644
--- a/libstdc++-v3/doc/xml/manual/diagnostics.xml
+++ b/libstdc++-v3/doc/xml/manual/diagnostics.xml
@@ -39,7 +39,7 @@
<para>
Derived from this are several classes that may have a
- <classname>string</classname> member: a full heirarchy can be
+ <classname>string</classname> member: a full hierarchy can be
found in the <ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00233.html">source documentation</ulink>.
</para>
diff --git a/libstdc++-v3/doc/xml/manual/evolution.xml b/libstdc++-v3/doc/xml/manual/evolution.xml
index 296e228..1973431 100644
--- a/libstdc++-v3/doc/xml/manual/evolution.xml
+++ b/libstdc++-v3/doc/xml/manual/evolution.xml
@@ -14,7 +14,7 @@
<title>API Evolution and Deprecation History</title>
<para>
-A list of user-visible changes, in cronological order
+A list of user-visible changes, in chronological order
</para>
<sect2 id="api.rel_300" xreflabel="api.rel_300">
@@ -135,7 +135,7 @@ _Alloc_traits</code> have been removed.
<para>
Previous versions prior to 3.4 cache allocations in a memory
pool, instead of passing through to call the global allocation
- operators (ie, <classname>__gnu_cxx::pool_allocator</classname>). More
+ operators (i.e., <classname>__gnu_cxx::pool_allocator</classname>). More
recent versions default to the
simpler <classname>__gnu_cxx::new_allocator</classname>.
</para>
@@ -449,4 +449,4 @@ Namespace pb_ds moved to __gnu_pb_ds.
</sect2>
-</sect1>
\ No newline at end of file
+</sect1>
diff --git a/libstdc++-v3/doc/xml/manual/extensions.xml b/libstdc++-v3/doc/xml/manual/extensions.xml
index 517d3bb..52cebab 100644
--- a/libstdc++-v3/doc/xml/manual/extensions.xml
+++ b/libstdc++-v3/doc/xml/manual/extensions.xml
@@ -357,7 +357,7 @@ get_temporary_buffer(5, (int*)0);
<listitem><para><code>is_sorted</code> tests whether or not a range is sorted in
nondescending order.</para></listitem>
</itemizedlist>
-<para>25.3.8 (lexigraphical_compare) is extended with
+<para>25.3.8 (lexicographical_compare) is extended with
</para>
<programlisting>
lexicographical_compare_3way(_InputIter1 first1, _InputIter1 last1,
@@ -488,7 +488,7 @@ get_temporary_buffer(5, (int*)0);
<chapter id="manual.ext.demangle" xreflabel="Demangling">
<title>Demangling</title>
<para>
- Transforming C++ ABI itentifiers (like RTTI symbols) into the
+ Transforming C++ ABI identifiers (like RTTI symbols) into the
original C++ source identifiers is called
<quote>demangling.</quote>
</para>
diff --git a/libstdc++-v3/doc/xml/manual/locale.xml b/libstdc++-v3/doc/xml/manual/locale.xml
index a4f20bd..b77fdfc 100644
--- a/libstdc++-v3/doc/xml/manual/locale.xml
+++ b/libstdc++-v3/doc/xml/manual/locale.xml
@@ -50,7 +50,7 @@ Literally, a facet is strictly defined:
<itemizedlist>
<listitem>
<para>
- Dontaining the following public data member:
+ Containing the following public data member:
</para>
<para>
<code>static locale::id id;</code>
@@ -95,13 +95,13 @@ Provides an index for looking up specific facets.
<para>
The major design challenge is fitting an object-orientated and
-non-global locale design ontop of POSIX and other relevant stanards,
+non-global locale design on top of POSIX and other relevant standards,
which include the Single Unix (nee X/Open.)
</para>
<para>
Because C and earlier versions of POSIX falls down so completely,
-portibility is an issue.
+portability is an issue.
</para>
</sect2>
@@ -461,7 +461,7 @@ global locale" (emphasis Paolo), that is:
<programlisting>std::setlocale(LC_ALL, "");</programlisting>
<para>
- On the other hand, there is *no* viceversa, that is, calling
+ On the other hand, there is *no* vice versa, that is, calling
setlocale has *no* whatsoever on the C++ locale mechanism, in
particular on the working of locale(""), which constructs the locale
object from the environment of the running program, that is, in
@@ -486,7 +486,7 @@ global locale" (emphasis Paolo), that is:
<listitem>
<para>
Document how named locales error check when filling data
- members. Ie, a fr_FR locale that doesn't have
+ members. I.e., a fr_FR locale that doesn't have
numpunct::truename(): does it use "true"? Or is it a blank
string? What's the convention?
</para>
@@ -504,7 +504,7 @@ global locale" (emphasis Paolo), that is:
<listitem>
<para>
What should non-required facet instantiations do? If the
- generic implemenation is provided, then how to end-users
+ generic implementation is provided, then how to end-users
provide specializations?
</para>
</listitem>
@@ -650,4 +650,4 @@ global locale" (emphasis Paolo), that is:
</bibliography>
-</sect1>
\ No newline at end of file
+</sect1>
diff --git a/libstdc++-v3/doc/xml/manual/messages.xml b/libstdc++-v3/doc/xml/manual/messages.xml
index d32620f..dcb504a 100644
--- a/libstdc++-v3/doc/xml/manual/messages.xml
+++ b/libstdc++-v3/doc/xml/manual/messages.xml
@@ -238,7 +238,7 @@ model.
library locale support is necessary for more than just the
<code>LC_MESSAGES</code> mask: <code>LC_CTYPE</code> is also
necessary. To avoid any unpleasantness, all bits of the "C" mask
- (ie <code>LC_ALL</code>) are set before retrieving messages.
+ (i.e. <code>LC_ALL</code>) are set before retrieving messages.
</para>
<para>
@@ -377,7 +377,7 @@ void test01()
There are issues with gettext needing the global locale set
to extract a message. This dependence on the global locale
makes the current "gnu" model non MT-safe. Future versions
- of glibc, ie glibc 2.3.x will fix this, and the C++ library
+ of glibc, i.e. glibc 2.3.x will fix this, and the C++ library
bits are already in place.
</para>
</listitem>
@@ -399,7 +399,7 @@ void test01()
<listitem>
<para>
At some point in the near future, std::numpunct will probably use
- std::messages facilities to implement truename/falename
+ std::messages facilities to implement truename/falsename
correctly. This is currently not done, but entries in
libstdc++.pot have already been made for "true" and "false" string
literals, so all that remains is the std::numpunct coding and the
@@ -601,4 +601,4 @@ Library and Tools.
</bibliography>
-</sect1>
\ No newline at end of file
+</sect1>
diff --git a/libstdc++-v3/doc/xml/manual/parallel_mode.xml b/libstdc++-v3/doc/xml/manual/parallel_mode.xml
index 449cbda..9193fd9 100644
--- a/libstdc++-v3/doc/xml/manual/parallel_mode.xml
+++ b/libstdc++-v3/doc/xml/manual/parallel_mode.xml
@@ -96,7 +96,7 @@ specific compiler flag.
<title>Semantics</title>
<para> The parallel mode STL algorithms are currently not exception-safe,
-i. e. user-defined functors must not throw exceptions.
+i.e. user-defined functors must not throw exceptions.
</para>
<para> Since the current GCC OpenMP implementation does not support
@@ -455,10 +455,10 @@ namespace std
}
</programlisting>
-<para>But.... why the elipses?
+<para>But.... why the ellipses?
</para>
-<para> The elipses in the example above represent additional overloads
+<para> The ellipses in the example above represent additional overloads
required for the parallel version of the function. These additional
overloads are used to dispatch calls from the ISO C++ function
signature to the appropriate parallel function (or sequential
@@ -467,7 +467,7 @@ compile-time or run-time conditions.
</para>
<para> Compile-time conditions are referred to as "embarrassingly
-parallel," and are denoted with the appropriate dispatch object, ie
+parallel," and are denoted with the appropriate dispatch object, i.e.,
one of <code>__gnu_parallel::sequential_tag</code>,
<code>__gnu_parallel::parallel_tag</code>,
<code>__gnu_parallel::balanced_tag</code>,
@@ -593,7 +593,7 @@ See <ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00505.ht
<title>Run Time Settings and Defaults</title>
<para>
-The default parallization strategy, the choice of specific algorithm
+The default parallelization strategy, the choice of specific algorithm
strategy, the minimum threshold limits for individual parallel
algorithms, and aspects of the underlying hardware can be specified as
desired via manipulation
@@ -608,7 +608,7 @@ value of enum <type>__gnu_parallel::_AlgorithmStrategy</type>
type. Choices
include: <type>heuristic</type>, <type>force_sequential</type>,
and <type>force_parallel</type>. The default is
-implementation-deduced, ie <type>heuristic</type>.
+implementation-deduced, i.e. <type>heuristic</type>.
</para>
@@ -626,7 +626,7 @@ or <type>QS_BALANCED</type>.
<para>
Likewise for setting the minimal threshold for algorithm
-paralleization. Parallelism always incurs some overhead. Thus, it is
+parallelization. Parallelism always incurs some overhead. Thus, it is
not helpful to parallelize operations on very small sets of
data. Because of this, measures are taken to avoid parallelizing below
a certain, pre-determined threshold. For each algorithm, a minimum
diff --git a/libstdc++-v3/doc/xml/manual/status_cxx200x.xml b/libstdc++-v3/doc/xml/manual/status_cxx200x.xml
index 1c6460a..367ea32 100644
--- a/libstdc++-v3/doc/xml/manual/status_cxx200x.xml
+++ b/libstdc++-v3/doc/xml/manual/status_cxx200x.xml
@@ -1052,7 +1052,7 @@ particular release.
</row>
<row>
<entry>26.4.7.2</entry>
- <entry>Function template <code>generate_cannonical</code></entry>
+ <entry>Function template <code>generate_canonical</code></entry>
<entry></entry>
<entry></entry>
<entry>missing</entry>
@@ -1079,7 +1079,7 @@ particular release.
<entry>Class template <code>uniform_int_distribution</code></entry>
<entry></entry>
<entry></entry>
- <entry>missing</entry>
+ entry>missing</entry>
<entry></entry>
</row>
<row>
@@ -2238,4 +2238,4 @@ Footnotes
shared_ptr</ulink> library.
</para>
-</sect2>
\ No newline at end of file
+</sect2>
diff --git a/libstdc++-v3/doc/xml/manual/strings.xml b/libstdc++-v3/doc/xml/manual/strings.xml
index d8f2035..418aa23 100644
--- a/libstdc++-v3/doc/xml/manual/strings.xml
+++ b/libstdc++-v3/doc/xml/manual/strings.xml
@@ -35,7 +35,7 @@
<code>transform<></code> is used.
</para>
<para>
- This code will go through some iterations. Here's a simiple
+ This code will go through some iterations. Here's a simple
version:
</para>
<programlisting>
@@ -126,7 +126,7 @@
</sect1>
<sect1 id="strings.string.case" xreflabel="Case Sensitivity">
- <title>Case Sensivitity</title>
+ <title>Case Sensitivity</title>
<para>
</para>
diff --git a/libstdc++-v3/doc/xml/manual/support.xml b/libstdc++-v3/doc/xml/manual/support.xml
index 5516959..3b0ad33 100644
--- a/libstdc++-v3/doc/xml/manual/support.xml
+++ b/libstdc++-v3/doc/xml/manual/support.xml
@@ -98,7 +98,7 @@
</para>
</sect1>
- <sect1 id="manual.support.types.numeric_limits" xreflabel="Numeric Properites">
+ <sect1 id="manual.support.types.numeric_limits" xreflabel="Numeric Properties">
<title>Numeric Properties</title>
diff --git a/libstdc++-v3/doc/xml/manual/test.xml b/libstdc++-v3/doc/xml/manual/test.xml
index 076138d..f9abbfd 100644
--- a/libstdc++-v3/doc/xml/manual/test.xml
+++ b/libstdc++-v3/doc/xml/manual/test.xml
@@ -511,7 +511,7 @@ runtest --tool libstdc++ --srcdir=/path/to/gcc/libstdc++-v3/testsuite
</para>
<para>
This file indicates that the host system can run tests which
- incolved multiple threads.
+ involved multiple threads.
</para>
</listitem>
@@ -563,7 +563,7 @@ runtest --tool libstdc++ --srcdir=/path/to/gcc/libstdc++-v3/testsuite
<para>
We are interested in any strange failures of the testsuite;
- please email the main libstdc++ mainling list if you see
+ please email the main libstdc++ mailing list if you see
something odd or have questions.
</para>
</sect3>
@@ -820,4 +820,4 @@ Currently plans for supported keywords include:
</sect2>
-</sect1>
\ No newline at end of file
+</sect1>
diff --git a/libstdc++-v3/doc/xml/manual/using.xml b/libstdc++-v3/doc/xml/manual/using.xml
index 2782596..6708683 100644
--- a/libstdc++-v3/doc/xml/manual/using.xml
+++ b/libstdc++-v3/doc/xml/manual/using.xml
@@ -110,7 +110,7 @@
</para>
<para>
- C++98/03 include files. These are available in the default compilation mode, ie <code>-std=c++98</code> or <code>-std=gnu++98</code>.
+ C++98/03 include files. These are available in the default compilation mode, i.e. <code>-std=c++98</code> or <code>-std=gnu++98</code>.
</para>
<table frame='all'>
@@ -149,7 +149,7 @@
</tgroup>
</table>
-<para>C++0x include files. These are only available in C++0x compilation mode, ie <code>-std=c++0x</code> or <code>-std=gnu++0x</code>.
+<para>C++0x include files. These are only available in C++0x compilation mode, i.e. <code>-std=c++0x</code> or <code>-std=gnu++0x</code>.
</para>
<para></para>
@@ -470,7 +470,7 @@ g++ -Winvalid-pch -I. -include stdc++.h -H -g -O2 hello.cc -o test.exe
<itemizedlist>
<listitem><para>std</para>
<para>The ISO C++ standards specify that "all library entities are defined
-within namespace std." This includes namepaces nested
+within namespace std." This includes namespaces nested
within <code>namespace std</code>, such as <code>namespace
std::tr1</code>.
</para>
@@ -521,7 +521,7 @@ cases where the qualified verbiage becomes unwieldy.)
</sect2>
- <sect2 id="manual.intro.using.namespaces.comp" xreflabel="Using Namepace Composition">
+ <sect2 id="manual.intro.using.namespaces.comp" xreflabel="Using Namespace Composition">
<title>Using Namespace Composition</title>
<para>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v3] libstdc++ xml doc typos
2008-03-24 17:30 [PATCH v3] libstdc++ xml doc typos Ralf Wildenhues
@ 2008-03-25 16:58 ` Benjamin Kosnik
2008-04-10 23:01 ` Benjamin Kosnik
0 siblings, 1 reply; 5+ messages in thread
From: Benjamin Kosnik @ 2008-03-25 16:58 UTC (permalink / raw)
To: Ralf Wildenhues; +Cc: gcc-patches, libstdc++
> Tested 'make doc-html-doxygen doc-man-doxygen doc-xml-doxygen'
> in $host/libstdc++-v3/doc, is that enough? doc-html and doc-pdf
> did not work for me, presumably due to Debian's differently named
> xml support files.
The include/* source files are really the only input for the doxygen
markup. So, the doc-*-doxygen rules don't especially matter for edits in the
docbook xml files. Although running them certainly doesn't hurt.
;)
doc-html is the rule that would regenerate the html files for you.
I would like to make sure that others can regenerate the
html files. Certainly, some improvement is needed. What kind of error do
you get when you try to do 'make doc-html'?
If you need to point to a different stylesheet location, you could use
something like
make XSL_STYLE_DIR=/path/to/stylesheetdirectory doc-html
or
make XSL_HTML_STYLE=/path/to/chunk.xsl doc-html
Can you try this and see if you can get it to work please?
doc-pdf is still a work in progress. See some of the LF summer of code
commentary for more background. I'm hoping somebody works on this for
SoC, or that the LF tries to improve this for everybody:
https://lists.linux-foundation.org/pipermail/lsb-discuss/2008-March/004795.html
> Please note that bitmap_allocator changes are a bit more than mere
> typos.
>
> OK for trunk? In case I have to commit regenerated files, can
> somebody apply the patch for me?
This is ok for trunk and gcc-4_3-branch: thanks again for all your
excellent help on the docs.
If you cannot regenerate, I'll do this for you.
-benjamin
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v3] libstdc++ xml doc typos
2008-03-25 16:58 ` Benjamin Kosnik
@ 2008-04-10 23:01 ` Benjamin Kosnik
2008-04-11 19:26 ` Ralf Wildenhues
0 siblings, 1 reply; 5+ messages in thread
From: Benjamin Kosnik @ 2008-04-10 23:01 UTC (permalink / raw)
To: Benjamin Kosnik; +Cc: Ralf Wildenhues, gcc-patches, libstdc++
[-- Attachment #1: Type: text/plain, Size: 515 bytes --]
Sorry about the delay here. Attached as checked in.
> > Tested 'make doc-html-doxygen doc-man-doxygen doc-xml-doxygen'
> > in $host/libstdc++-v3/doc, is that enough?
make doc-xml-validate
makes sure the markup is valid. (One entry tag was missing '<').
> I would like to make sure that others can regenerate the
> html files. Certainly, some improvement is needed. What kind of error
> do you get when you try to do 'make doc-html'?
Anybody? I just need to make sure it works for somebody else.
-benjamin
[-- Attachment #2: p.20080410-5.bz2 --]
[-- Type: application/x-bzip, Size: 42378 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v3] libstdc++ xml doc typos
2008-04-10 23:01 ` Benjamin Kosnik
@ 2008-04-11 19:26 ` Ralf Wildenhues
2008-04-18 17:52 ` Benjamin Kosnik
0 siblings, 1 reply; 5+ messages in thread
From: Ralf Wildenhues @ 2008-04-11 19:26 UTC (permalink / raw)
To: Benjamin Kosnik; +Cc: gcc-patches, libstdc++
Hello Benjamin,
* Benjamin Kosnik wrote on Fri, Apr 11, 2008 at 12:21:52AM CEST:
>
> Sorry about the delay here. Attached as checked in.
Thanks, and sorry about not having gotten back to you before.
> > I would like to make sure that others can regenerate the
> > html files. Certainly, some improvement is needed. What kind of error
> > do you get when you try to do 'make doc-html'?
>
> Anybody? I just need to make sure it works for somebody else.
Generating html files...
xsltproc --nonet --xinclude -o /home/ralf/download/cvs/gcc/build/i686-pc-linux-gnu/libstdc++-v3/doc/html/ \
/usr/share/sgml/docbook/xsl-stylesheets/xhtml/chunk.xsl ../../../../gcc/libstdc++-v3/doc/xml/spine.xml
warning: failed to load external entity "/usr/share/sgml/docbook/xsl-stylesheets/xhtml/chunk.xsl"
cannot parse /usr/share/sgml/docbook/xsl-stylesheets/xhtml/chunk.xsl
make: *** [doc-html] Fehler 4
> If you need to point to a different stylesheet location, you could use
> something like
>
> make XSL_STYLE_DIR=/path/to/stylesheetdirectory doc-html
> Can you try this and see if you can get it to work please?
$ make doc-html XSL_STYLE_DIR=/usr/share/xml/docbook/stylesheet/nwalsh
works, but the result is slightly different than what is checked in, and
also things are generated in the build tree and not in the source tree.
As far as I can see, the differences are mostly in anchor ids:
| Only in ../../../../gcc/libstdc++-v3/doc/html/: README
| diff -r ../../../../gcc/libstdc++-v3/doc/html/api.html html/api.html
| 8c8
| < </p></div><div><div class="legalnotice"><a id="id478877"></a><p>
| ---
| > </p></div><div><div class="legalnotice"><a id="id2688074"></a><p>
| Only in ../../../../gcc/libstdc++-v3/doc/html/: ext
| Only in ../../../../gcc/libstdc++-v3/doc/html/: index.html
| diff -r ../../../../gcc/libstdc++-v3/doc/html/manual/abi.html html/manual/abi.html
[...]
Do these matter, or have I maybe used the wrong XSLT? If the latter,
I'd appreciate if someone knew the package I'd need to install.
Cheers,
Ralf
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v3] libstdc++ xml doc typos
2008-04-11 19:26 ` Ralf Wildenhues
@ 2008-04-18 17:52 ` Benjamin Kosnik
0 siblings, 0 replies; 5+ messages in thread
From: Benjamin Kosnik @ 2008-04-18 17:52 UTC (permalink / raw)
To: Ralf Wildenhues; +Cc: gcc-patches, libstdc++
> Generating html files...
> xsltproc --nonet --xinclude
> -o /home/ralf/download/cvs/gcc/build/i686-pc-linux-gnu/libstdc++-v3/doc/html/
> \ /usr/share/sgml/docbook/xsl-stylesheets/xhtml/chunk.xsl ../../../../gcc/libstdc++-v3/doc/xml/spine.xml
> warning: failed to load external entity
> "/usr/share/sgml/docbook/xsl-stylesheets/xhtml/chunk.xsl" cannot
> parse /usr/share/sgml/docbook/xsl-stylesheets/xhtml/chunk.xsl make:
> *** [doc-html] Fehler 4
>
> > If you need to point to a different stylesheet location, you could
> > use something like
> >
> > make XSL_STYLE_DIR=/path/to/stylesheetdirectory doc-html
>
> > Can you try this and see if you can get it to work please?
>
> $ make doc-html XSL_STYLE_DIR=/usr/share/xml/docbook/stylesheet/nwalsh
>
> works, but the result is slightly different than what is checked in,
> and also things are generated in the build tree and not in the source
> tree.
Yeah, I'm trying to make all generated documentation in the build tree,
not the source tree. Seems like the Right Thing To Do.
So, after the docbook html is generated, then I hand-copy the generated
html to the doc/html directory for checkin.
> As far as I can see, the differences are mostly in anchor ids:
>
> | Only in ../../../../gcc/libstdc++-v3/doc/html/: README
> | diff -r ../../../../gcc/libstdc++-v3/doc/html/api.html html/api.html
> | 8c8
> | < </p></div><div><div class="legalnotice"><a
> id="id478877"></a><p> | ---
> | > </p></div><div><div class="legalnotice"><a
> id="id2688074"></a><p> | Only
> in ../../../../gcc/libstdc++-v3/doc/html/: ext | Only
> in ../../../../gcc/libstdc++-v3/doc/html/: index.html | diff
> -r ../../../../gcc/libstdc++-v3/doc/html/manual/abi.html
> html/manual/abi.html [...]
>
> Do these matter, or have I maybe used the wrong XSLT? If the latter,
> I'd appreciate if someone knew the package I'd need to install.
That does matter a tiny bit, but it's just due to the different XSLT
package.
I am using:
docbook-style-xsl-1.73.2-5.fc8
You should be able to download them from:
http://sourceforge.net/project/showfiles.php?group_id=21935
best,
benjamin
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2008-04-18 16:19 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2008-03-24 17:30 [PATCH v3] libstdc++ xml doc typos Ralf Wildenhues
2008-03-25 16:58 ` Benjamin Kosnik
2008-04-10 23:01 ` Benjamin Kosnik
2008-04-11 19:26 ` Ralf Wildenhues
2008-04-18 17:52 ` Benjamin Kosnik
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).