Skip to content

Commit 56b4ef8

Browse files
deanberrisdeanberris
committed
Updating documentation.
1 parent b741b4f commit 56b4ef8

20 files changed

+440
-89
lines changed

‎README.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -167,26 +167,21 @@ repository. It is recommended that forks be made against the upstream repostory
167167
and pull requests be submitted against the upstream repository so that patches
168168
and other implementations can be curated by the original maintainer.
169169

170-
Contact and Commercial Support
171-
------------------------------
170+
Contact and Support
171+
-------------------
172172

173173
In case you have any questions or would like to make feature requests, you can
174174
contact the development team through the `developers mailing list`_
175-
or by filing issues at http://github.com/mikhailberis/cpp-netlib/issues.
175+
or by filing issues at http://github.com/cpp-netlib/cpp-netlib/issues.
176176

177177
.. _`developers mailing list`:
178178
https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel
179179

180180
You can reach the maintainers of the project through::
181181

182-
Dean Michael Berris
183-
mikhailberis@gmail.com
182+
Dean Michael Berris (dberris@google.com)
184183

185184
Glyn Matthews
186185

187186
Mike Dickey
188187

189-
At this time, paid commercial support is available for cpp-netlib being offered
190-
by the maintainers. In case you have any questions, please feel free to contact
191-
any one of the maintainers above or anybody on the developers mailing list.
192-

‎boost/network/protocol/http/client.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ namespace boost { namespace network { namespace http {
3434
: basic_client_facade<Tag, version_major, version_minor>
3535
{
3636
private:
37-
typedef basic_client_facade<Tag, version_major, version_minor>
37+
typedef basic_client_facade<Tag, version_major, version_minor>
3838
base_facade_type;
3939
public:
4040
typedef basic_request<Tag> request;
@@ -65,7 +65,7 @@ namespace boost { namespace network { namespace http {
6565

6666
BOOST_PARAMETER_CONSTRUCTOR(
6767
basic_client, (base_facade_type), tag,
68-
(optional
68+
(optional
6969
(in_out(io_service), (boost::asio::io_service&))
7070
(follow_redirects, (bool))
7171
(cache_resolved, (bool))

‎libs/network/doc/getting_started.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Getting Boost
7070
=============
7171

7272
:mod:`cpp-netlib` depends on Boost_. It should work for any version
73-
of Boost above 1.43.0. If Boost is not installed on your system, the
73+
of Boost above 1.45.0. If Boost is not installed on your system, the
7474
latest package can be found on the `Boost web-site`_. The environment
7575
variable ``BOOST_ROOT`` must be defined, which must be the full path
7676
name of the top directory of the Boost distribution. Although Boost
@@ -90,6 +90,11 @@ still requires linking with `Boost.System`_, `Boost.Date_time`_, and
9090
.. _`Boost Getting Started`:
9191
http://www.boost.org/doc/libs/release/more/getting_started/index.html
9292

93+
.. warning:: There is a known incompatibility between :mod:`cpp-netlib` and
94+
Boost 1.46.1 on some compilers. It is not recommended to use :mod:`cpp-netlib`
95+
with Boost 1.46.1. Some have reported though that Boost 1.47.0
96+
and :mod:`cpp-netlib` work together better.
97+
9398
Getting CMake
9499
=============
95100

@@ -168,9 +173,5 @@ for the project at http://github.com/cpp-netlib/cpp-netlib/issues.
168173

169174
You can also opt to join the developers mailing list for a more personal
170175
interaction with the developers of the project. You can join the mailing list
171-
through https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel.
172-
173-
You may also choose to get commercial support from:
174-
175-
Dean Michael Berris - <me@deanberris.com>
176+
through https://groups.google.com/group/cpp-netlib.
176177

‎libs/network/doc/hello_world_server.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ simple response to any HTTP request.
3838

3939
int
4040
main(int argc, char * argv[]) {
41-
41+
4242
if (argc != 3) {
4343
std::cerr << "Usage: " << argv[0] << " address port" << std::endl;
4444
return 1;
4545
}
46-
46+
4747
try {
4848
hello_world handler;
4949
server server_(argv[1], argv[2], handler);
@@ -53,7 +53,7 @@ simple response to any HTTP request.
5353
std::cerr << e.what() << std::endl;
5454
return 1;
5555
}
56-
56+
5757
return 0;
5858
}
5959

@@ -115,9 +115,9 @@ This header contains all the code needed to develop an HTTP server with
115115
``hello_world`` is a functor class which handles HTTP requests. All
116116
the operator does here is return an HTTP response with HTTP code 200
117117
and the body ``"Hello, <ip>!"``. The ``<ip>`` in this case would be
118-
the IP address of the client that made the request.
118+
the IP address of the client that made the request.
119119

120-
There are a number of pre-defined stock replies differentiated by
120+
There are a number of pre-defined stock replies differentiated by
121121
status code with configurable bodies.
122122

123123
All the supported enumeration values for the response status codes can be found
@@ -134,10 +134,10 @@ the port on which the server will listen. The third argument is the
134134
the handler object defined previously.
135135

136136
.. note:: In this example, the server is specifically made to be single-threaded.
137-
In a multi-threaded server, you would invoke the ``hello_world::run`` member
138-
method in a set of threads. In a multi-threaded environment you would also
139-
make sure that the handler does all the necessary synchronization for shared
140-
resources across threads. The handler is passed by reference to the server
141-
constructor and you should ensure that any calls to the ``operator()`` overload
137+
In a multi-threaded server, you would invoke the ``hello_world::run`` member
138+
method in a set of threads. In a multi-threaded environment you would also
139+
make sure that the handler does all the necessary synchronization for shared
140+
resources across threads. The handler is passed by reference to the server
141+
constructor and you should ensure that any calls to the ``operator()`` overload
142142
are thread-safe.
143143

‎libs/network/doc/html/_sources/getting_started.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Getting Boost
7070
=============
7171

7272
:mod:`cpp-netlib` depends on Boost_. It should work for any version
73-
of Boost above 1.43.0. If Boost is not installed on your system, the
73+
of Boost above 1.45.0. If Boost is not installed on your system, the
7474
latest package can be found on the `Boost web-site`_. The environment
7575
variable ``BOOST_ROOT`` must be defined, which must be the full path
7676
name of the top directory of the Boost distribution. Although Boost
@@ -90,6 +90,11 @@ still requires linking with `Boost.System`_, `Boost.Date_time`_, and
9090
.. _`Boost Getting Started`:
9191
http://www.boost.org/doc/libs/release/more/getting_started/index.html
9292

93+
.. warning:: There is a known incompatibility between :mod:`cpp-netlib` and
94+
Boost 1.46.1 on some compilers. It is not recommended to use :mod:`cpp-netlib`
95+
with Boost 1.46.1. Some have reported though that Boost 1.47.0
96+
and :mod:`cpp-netlib` work together better.
97+
9398
Getting CMake
9499
=============
95100

@@ -168,9 +173,5 @@ for the project at http://github.com/cpp-netlib/cpp-netlib/issues.
168173

169174
You can also opt to join the developers mailing list for a more personal
170175
interaction with the developers of the project. You can join the mailing list
171-
through https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel.
172-
173-
You may also choose to get commercial support from:
174-
175-
Dean Michael Berris - <me@deanberris.com>
176+
through https://groups.google.com/group/cpp-netlib.
176177

‎libs/network/doc/html/_sources/hello_world_server.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ simple response to any HTTP request.
3838

3939
int
4040
main(int argc, char * argv[]) {
41-
41+
4242
if (argc != 3) {
4343
std::cerr << "Usage: " << argv[0] << " address port" << std::endl;
4444
return 1;
4545
}
46-
46+
4747
try {
4848
hello_world handler;
4949
server server_(argv[1], argv[2], handler);
@@ -53,7 +53,7 @@ simple response to any HTTP request.
5353
std::cerr << e.what() << std::endl;
5454
return 1;
5555
}
56-
56+
5757
return 0;
5858
}
5959

@@ -115,9 +115,9 @@ This header contains all the code needed to develop an HTTP server with
115115
``hello_world`` is a functor class which handles HTTP requests. All
116116
the operator does here is return an HTTP response with HTTP code 200
117117
and the body ``"Hello, <ip>!"``. The ``<ip>`` in this case would be
118-
the IP address of the client that made the request.
118+
the IP address of the client that made the request.
119119

120-
There are a number of pre-defined stock replies differentiated by
120+
There are a number of pre-defined stock replies differentiated by
121121
status code with configurable bodies.
122122

123123
All the supported enumeration values for the response status codes can be found
@@ -134,10 +134,10 @@ the port on which the server will listen. The third argument is the
134134
the handler object defined previously.
135135

136136
.. note:: In this example, the server is specifically made to be single-threaded.
137-
In a multi-threaded server, you would invoke the ``hello_world::run`` member
138-
method in a set of threads. In a multi-threaded environment you would also
139-
make sure that the handler does all the necessary synchronization for shared
140-
resources across threads. The handler is passed by reference to the server
141-
constructor and you should ensure that any calls to the ``operator()`` overload
137+
In a multi-threaded server, you would invoke the ``hello_world::run`` member
138+
method in a set of threads. In a multi-threaded environment you would also
139+
make sure that the handler does all the necessary synchronization for shared
140+
resources across threads. The handler is passed by reference to the server
141+
constructor and you should ensure that any calls to the ``operator()`` overload
142142
are thread-safe.
143143

‎libs/network/doc/html/_sources/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Support
105105
You can ask questions, join the discussion, and report issues to the developers
106106
mailing list by joining via:
107107

108-
https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel
108+
https://groups.google.com/group/cpp-netlib
109109

110110
You may also file issues on the Github_ issue tracker at:
111111

0 commit comments

Comments
 (0)