Skip to content

Commit 4287ba3

Browse files
authored
docs: correct spelling and grammar
1 parent fd4a02f commit 4287ba3

File tree

13 files changed

+41
-41
lines changed

13 files changed

+41
-41
lines changed

doc/acknowledgements.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<section>
99
<title>Acknowledgements</title>
1010

11-
<para>I'm very gratefull to all the people who helped with the development,
11+
<para>I'm very grateful to all the people who helped with the development,
1212
by discussion, fixes, and as users. It was pleasant
1313
to see all that involvement, which made the library much better than it
1414
would be otherwise.
@@ -25,7 +25,7 @@
2525
<para>The formal review lead to numerous comments and enhancements. Pavol
2626
Droba helped with the option description semantic. Gennadiy Rozental has
2727
criticised many aspects of the library which caused various simplifications.
28-
Pavel Vozenilek did carefull review of the implementation. A number of
28+
Pavel Vozenilek did careful review of the implementation. A number of
2929
comments were made by:
3030
<itemizedlist>
3131
<listitem><para>David Abrahams</para></listitem>

doc/design.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
of the library -- ascii and Unicode.
7575
</para>
7676

77-
<para>Another important point is that ascii strings are passed though
77+
<para>Another important point is that ascii strings are passed through
7878
without modification. In other words, it's not possible to just convert
7979
ascii to Unicode and process the Unicode further. The problem is that the
8080
default conversion mechanism -- the <code>codecvt</code> facet -- might
@@ -85,7 +85,7 @@
8585
don't support Unicode option names. Unicode support is hard and
8686
requires a Boost-wide solution. Even comparing two arbitrary Unicode
8787
strings is non-trivial. Finally, using Unicode in option names is
88-
related to internationalization, which has it's own
88+
related to internationalization, which has its own
8989
complexities. E.g. if option names depend on current locale, then all
9090
program parts and other parts which use the name must be
9191
internationalized too.
@@ -210,4 +210,4 @@
210210
sgml-parent-document: ("program_options.xml" "section")
211211
sgml-set-face: t
212212
End:
213-
-->
213+
-->

doc/howto.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ options groups/hidden options
2323
<title>Non-conventional Syntax</title>
2424

2525
<para>Sometimes, standard command line syntaxes are not enough. For
26-
example, the gcc compiler has "-frtti" and -fno-rtti" options, and this
26+
example, the gcc compiler has "-frtti" and "-fno-rtti" options, and this
2727
syntax is not directly supported.
2828
</para>
2929

@@ -66,7 +66,7 @@ store(command_line_parser(ac, av).options(desc).extra_parser(reg_foo)
6666

6767
<indexterm><primary>response files</primary></indexterm>
6868

69-
<para>Some operating system have very low limits of the command line
69+
<para>Some operating systems have very low limits of the command line
7070
length. The common way to work around those limitations is using
7171
<firstterm>response files</firstterm>. A response file is just a
7272
configuration file which uses the same syntax as the command line. If
@@ -304,7 +304,7 @@ void validate(boost::any& v,
304304
for the value, and in this case is either empty or contains an instance of
305305
the <code>magic_number</code> class. The second is the list of strings
306306
found in the next occurrence of the option. The remaining two parameters
307-
are needed to workaround the lack of partial template specialization and
307+
are needed to work around the lack of partial template specialization and
308308
partial function template ordering on some compilers.
309309
</para>
310310

@@ -346,7 +346,7 @@ void validate(boost::any& v,
346346
<emphasis>some</emphasis> Unicode-aware options. They are different from
347347
ordinary options in that they accept <code>wstring</code> input, and
348348
process it using wide character streams. Creating an Unicode-aware option
349-
is easy: just use the the <code>wvalue</code> function instead of the
349+
is easy: just use the <code>wvalue</code> function instead of the
350350
regular <code>value</code>.
351351
</para>
352352

@@ -379,7 +379,7 @@ locale::global(locale(""));
379379
implementation, though. The quick test involves three steps:
380380
<orderedlist>
381381
<listitem>
382-
<para>Go the the "test" directory and build the "test_convert" binary.</para>
382+
<para>Go to the "test" directory and build the "test_convert" binary.</para>
383383
</listitem>
384384
<listitem>
385385
<para>Set some non-ascii locale in the environment. On Linux, one can

doc/overview.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
provides a class which stores all option values and that class can be
5151
freely passed around your program to modules which need access to the
5252
options. All the other components can be used only in the place where
53-
the actual parsing is the done. However, it might also make sense for the
53+
the actual parsing is done. However, it might also make sense for the
5454
individual program modules to describe their options and pass them to the
5555
main module, which will merge all options. Of course, this is only
5656
important when the number of options is large and declaring them in one
@@ -208,7 +208,7 @@ desc.add_options()
208208
<para>The description string has one or more paragraphs, separated by
209209
the newline character ('\n'). When an option is output, the library
210210
will compute the indentation for options's description. Each of the
211-
paragraph is output as a separate line with that intentation. If
211+
paragraph is output as a separate line with that indentation. If
212212
a paragraph does not fit on one line it is spanned over multiple
213213
lines (which will have the same indentation).
214214
</para>
@@ -538,21 +538,21 @@ desc.add_options()
538538
</para>
539539

540540
<para>The environment variables can be parsed with the
541-
&parse_environment; function. The function have several overloaded
541+
&parse_environment; function. The function has several overloaded
542542
versions. The first parameter is always an &options_description;
543543
instance, and the second specifies what variables must be processed, and
544544
what option names must correspond to it. To describe the second
545545
parameter we need to consider naming conventions for environment
546546
variables.</para>
547547

548548
<para>If you have an option that should be specified via environment
549-
variable, you need make up the variable's name. To avoid name clashes,
549+
variable, you need to make up the variable's name. To avoid name clashes,
550550
we suggest that you use a sufficiently unique prefix for environment
551551
variables. Also, while option names are most likely in lower case,
552552
environment variables conventionally use upper case. So, for an option
553553
name <literal>proxy</literal> the environment variable might be called
554554
<envar>BOOST_PROXY</envar>. During parsing, we need to perform reverse
555-
conversion of the names. This is accomplished by passing the choosen
555+
conversion of the names. This is accomplished by passing the chosen
556556
prefix as the second parameter of the &parse_environment; function.
557557
Say, if you pass <literal>BOOST_</literal> as the prefix, and there are
558558
two variables, <envar>CVSROOT</envar> and <envar>BOOST_PROXY</envar>, the
@@ -588,7 +588,7 @@ desc.add_options()
588588
representations that are available in C++ literals are not supported by
589589
lexical_cast, and thus will not work with program_options.</para>
590590

591-
<para>Booleans a special in that there are multiple ways to come at them.
591+
<para>Booleans are special in that there are multiple ways to come at them.
592592
Similar to another value type, it can be specified as <code>("my-option",
593593
value&lt;bool&gt;())</code>, and then set as:</para>
594594
<screen>
@@ -648,7 +648,7 @@ example --other-switch
648648

649649
<row>
650650
<entry>&parse_command_line;</entry>
651-
<entry>parses command line (simpified interface)</entry>
651+
<entry>parses command line (simplified interface)</entry>
652652
</row>
653653

654654
<row>

doc/program_options.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
</para>
7171

7272
<para>
73-
Now let's see some examples of the library usage in the <xref
73+
Now let's see some examples of the library usage in <xref
7474
linkend="program_options.tutorial"/>.
7575
</para>
7676

include/boost/program_options/cmdline.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
namespace boost { namespace program_options { namespace command_line_style {
1010
/** Various possible styles of options.
1111
12-
There are "long" options, which start with "--" and "short",
12+
There are "long" options, which start with "--", and "short",
1313
which start with either "-" or "/". Both kinds can be allowed or
1414
disallowed, see allow_long and allow_short. The allowed character
1515
for short options is also configurable.
@@ -51,7 +51,7 @@ namespace boost { namespace program_options { namespace command_line_style {
5151
/** Allow to merge several short options together,
5252
so that "-s -k" become "-sk". All of the options
5353
but last should accept no parameter. For example, if
54-
"-s" accept a parameter, then "k" will be taken as
54+
"-s" accepts a parameter, then "k" will be taken as
5555
parameter, not another short option.
5656
Dos-style short options cannot be sticky.
5757
*/

include/boost/program_options/eof_iterator.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111
namespace boost {
1212

1313
/** The 'eof_iterator' class is useful for constructing forward iterators
14-
in cases where iterator extract data from some source and it's easy
14+
in cases where the iterator extracts data from some source and it's easy
1515
to detect 'eof' \-- i.e. the situation where there's no data. One
1616
apparent example is reading lines from a file.
1717
1818
Implementing such iterators using 'iterator_facade' directly would
19-
require to create class with three core operation, a couple of
19+
require to create class with three core operations, a couple of
2020
constructors. When using 'eof_iterator', the derived class should define
2121
only one method to get new value, plus a couple of constructors.
2222

include/boost/program_options/errors.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ namespace boost { namespace program_options {
5151
{}
5252
};
5353

54-
/** Class thrown when there are programming error related to style */
54+
/** Class thrown when there are programming errors related to style */
5555
class BOOST_PROGRAM_OPTIONS_DECL BOOST_SYMBOL_VISIBLE invalid_command_line_style : public error {
5656
public:
5757
invalid_command_line_style(const std::string& msg)
@@ -83,7 +83,7 @@ namespace boost { namespace program_options {
8383
* Options are displayed in "canonical" form
8484
* This is the most unambiguous form of the
8585
* *parsed* option name and would correspond to
86-
* option_description::format_name()
86+
* option_description::format_name(),
8787
* i.e. what is shown by print_usage()
8888
*
8989
* The "canonical" form depends on whether the option is
@@ -243,7 +243,7 @@ namespace boost { namespace program_options {
243243
* It makes no sense to have an option name, when we can't match an option to the
244244
* parameter
245245
*
246-
* Having this a part of the error_with_option_name hierachy makes error handling
246+
* Having this as part of the error_with_option_name hierarchy makes error handling
247247
* a lot easier, even if the name indicates some sort of conceptual dissonance!
248248
*
249249
* */
@@ -275,7 +275,7 @@ namespace boost { namespace program_options {
275275

276276

277277

278-
/** Class thrown when there's ambiguity amoung several possible options. */
278+
/** Class thrown when there's ambiguity among several possible options. */
279279
class BOOST_PROGRAM_OPTIONS_DECL BOOST_SYMBOL_VISIBLE ambiguous_option : public error_with_no_option_name {
280280
public:
281281
ambiguous_option(const std::vector<std::string>& xalternatives)

include/boost/program_options/options_description.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ namespace program_options {
105105

106106

107107
/** Returns the canonical name for the option description to enable the user to
108-
recognised a matching option.
108+
recognise a matching option.
109109
1) For short options ('-', '/'), returns the short name prefixed.
110110
2) For long options ('--' / '-') returns the first long name prefixed
111111
3) All other cases, returns the first long name (if present) or the short

include/boost/program_options/parsers.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ namespace boost { namespace program_options {
150150
instance of basic_option<charT> will be added to result,
151151
with 'unrecognized' field set to 'true'. It's possible to
152152
collect all unrecognized options with the 'collect_unrecognized'
153-
funciton.
153+
function.
154154
*/
155155
basic_command_line_parser& allow_unregistered();
156156

@@ -214,7 +214,7 @@ namespace boost { namespace program_options {
214214
/** Collects the original tokens for all named options with
215215
'unregistered' flag set. If 'mode' is 'include_positional'
216216
also collects all positional options.
217-
Returns the vector of origianl tokens for all collected
217+
Returns the vector of original tokens for all collected
218218
options.
219219
*/
220220
template<class charT>
@@ -254,8 +254,8 @@ namespace boost { namespace program_options {
254254

255255
/** Splits a given string to a collection of single strings which
256256
can be passed to command_line_parser. The second parameter is
257-
used to specify a collection of possible seperator chars used
258-
for splitting. The seperator is defaulted to space " ".
257+
used to specify a collection of possible separator chars used
258+
for splitting. The separator is defaulted to space " ".
259259
Splitting is done in a unix style way, with respect to quotes '"'
260260
and escape characters '\'
261261
*/

0 commit comments

Comments
 (0)