Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit7ca359c

Browse files
committed
Updated documentation about cpp-netlib libraries.
1 parent9612d7f commit7ca359c

File tree

11 files changed

+87
-20
lines changed

11 files changed

+87
-20
lines changed

‎libs/network/doc/getting_started.rst‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,19 +119,25 @@ build system to use our compiler of choice. This is done by running the
119119
``cmake`` command at the top-level directory of:mod:`cpp-netlib` with
120120
additional parameters::
121121

122-
$ cd ~/cpp-netlib
122+
$ mkdir ~/cpp-netlib-build
123+
$ cd ~/cpp-netlib-build
123124
$ cmake -DCMAKE_BUILD_TYPE=Debug \
124125
> -DCMAKE_C_COMPILER=gcc \
125126
> -DCMAKE_CXX_COMPILER=g++ \
126-
> .
127+
> ../cpp-netlib
128+
129+
..note::While it's not compulsory, it's recommended that
130+
:mod:`cpp-netlib` is built outside the source directory.
131+
For the purposes of documentation, we'll assume that all
132+
builds are done in ``~/cpp-netlib-build``.
127133

128134
Building on Linux
129135
~~~~~~~~~~~~~~~~~
130136

131137
On Linux, this will generate the appropriate Makefiles that will enable you to
132138
build and run the tests and examples that come with:mod:`cpp-netlib`. To build
133139
the tests, you can run ``make`` in the same top-level directory of
134-
:mod:`cpp-netlib`::
140+
``~/cpp-netlib-build``::
135141

136142
$ make
137143

@@ -162,6 +168,21 @@ look for the solution and project files as the artifacts of the call to
162168
``cmake`` -- the file should be named ``CPP-NETLIB.sln`` (the solution) along
163169
with a number of project files for Visual Studio.
164170

171+
..note::As of version 0.9.3, :mod:`cpp-netlib` produces three static
172+
libraries. Using GCC on Linux these are::
173+
174+
libcppnetlib-client-connections.a
175+
libcppnetlib-server-parsers.a
176+
libcppnetlib-uri.a
177+
178+
And using Visual C++ on Windows they are::
179+
180+
cppnetlib-client-connections.lib
181+
cppnetlib-server-parsers.lib
182+
cppnetlib-uri.lib
183+
184+
Users can find them in ``~/cpp-netlib-build/libs/network/src``.
185+
165186
Reporting Issues, Getting Support
166187
=================================
167188

13.1 KB
Loading
25 KB
Loading
20.2 KB
Loading
9.98 KB
Loading

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

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,19 +119,25 @@ build system to use our compiler of choice. This is done by running the
119119
``cmake`` command at the top-level directory of :mod:`cpp-netlib` with
120120
additional parameters::
121121

122-
$ cd ~/cpp-netlib
122+
$ mkdir ~/cpp-netlib-build
123+
$ cd ~/cpp-netlib-build
123124
$ cmake -DCMAKE_BUILD_TYPE=Debug \
124125
> -DCMAKE_C_COMPILER=gcc \
125126
> -DCMAKE_CXX_COMPILER=g++ \
126-
> .
127+
> ../cpp-netlib
128+
129+
.. note:: While it's not compulsory, it's recommended that
130+
:mod:`cpp-netlib` is built outside the source directory.
131+
For the purposes of documentation, we'll assume that all
132+
builds are done in ``~/cpp-netlib-build``.
127133

128134
Building on Linux
129135
~~~~~~~~~~~~~~~~~
130136

131137
On Linux, this will generate the appropriate Makefiles that will enable you to
132138
build and run the tests and examples that come with :mod:`cpp-netlib`. To build
133139
the tests, you can run ``make`` in the same top-level directory of
134-
:mod:`cpp-netlib`::
140+
``~/cpp-netlib-build``::
135141

136142
$ make
137143

@@ -162,6 +168,21 @@ look for the solution and project files as the artifacts of the call to
162168
``cmake`` -- the file should be named ``CPP-NETLIB.sln`` (the solution) along
163169
with a number of project files for Visual Studio.
164170

171+
.. note:: As of version 0.9.3, :mod:`cpp-netlib` produces three static
172+
libraries. Using GCC on Linux these are::
173+
174+
libcppnetlib-client-connections.a
175+
libcppnetlib-server-parsers.a
176+
libcppnetlib-uri.a
177+
178+
And using Visual C++ on Windows they are::
179+
180+
cppnetlib-client-connections.lib
181+
cppnetlib-server-parsers.lib
182+
cppnetlib-uri.lib
183+
184+
Users can find them in ``~/cpp-netlib-build/libs/network/src``.
185+
165186
Reporting Issues, Getting Support
166187
=================================
167188

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

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,18 +145,26 @@ <h2>Building with CMake<a class="headerlink" href="#building-with-cmake" title="
145145
build system to use our compiler of choice. This is done by running the
146146
<ttclass="docutils literal"><spanclass="pre">cmake</span></tt> command at the top-level directory of<ttclass="xref py py-mod docutils literal"><spanclass="pre">cpp-netlib</span></tt> with
147147
additional parameters:</p>
148-
<divclass="highlight-python"><pre>$ cd ~/cpp-netlib
148+
<divclass="highlight-python"><pre>$ mkdir ~/cpp-netlib-build
149+
$ cd ~/cpp-netlib-build
149150
$ cmake -DCMAKE_BUILD_TYPE=Debug \
150151
&gt; -DCMAKE_C_COMPILER=gcc \
151152
&gt; -DCMAKE_CXX_COMPILER=g++ \
152-
&gt; .</pre>
153+
&gt; ../cpp-netlib</pre>
154+
</div>
155+
<divclass="admonition note">
156+
<pclass="first admonition-title">Note</p>
157+
<pclass="last">While it&#8217;s not compulsory, it&#8217;s recommended that
158+
<ttclass="xref py py-mod docutils literal"><spanclass="pre">cpp-netlib</span></tt> is built outside the source directory.
159+
For the purposes of documentation, we&#8217;ll assume that all
160+
builds are done in<ttclass="docutils literal"><spanclass="pre">~/cpp-netlib-build</span></tt>.</p>
153161
</div>
154162
<divclass="section"id="building-on-linux">
155163
<h3>Building on Linux<aclass="headerlink"href="#building-on-linux"title="Permalink to this headline"></a></h3>
156164
<p>On Linux, this will generate the appropriate Makefiles that will enable you to
157165
build and run the tests and examples that come with<ttclass="xref py py-mod docutils literal"><spanclass="pre">cpp-netlib</span></tt>. To build
158166
the tests, you can run<ttclass="docutils literal"><spanclass="pre">make</span></tt> in the same top-level directory of
159-
<ttclass="xref py py-moddocutils literal"><spanclass="pre">cpp-netlib</span></tt>:</p>
167+
<ttclass="docutils literal"><spanclass="pre">~/cpp-netlib-build</span></tt>:</p>
160168
<divclass="highlight-python"><pre>$ make</pre>
161169
</div>
162170
<divclass="admonition note">
@@ -184,6 +192,23 @@ <h3>Building On Windows<a class="headerlink" href="#building-on-windows" title="
184192
look for the solution and project files as the artifacts of the call to
185193
<ttclass="docutils literal"><spanclass="pre">cmake</span></tt> &#8211; the file should be named<ttclass="docutils literal"><spanclass="pre">CPP-NETLIB.sln</span></tt> (the solution) along
186194
with a number of project files for Visual Studio.</p>
195+
<divclass="admonition note">
196+
<pclass="first admonition-title">Note</p>
197+
<p>As of version 0.9.3,<ttclass="xref py py-mod docutils literal"><spanclass="pre">cpp-netlib</span></tt> produces three static
198+
libraries. Using GCC on Linux these are:</p>
199+
<divclass="highlight-python"><divclass="highlight"><pre><spanclass="n">libcppnetlib</span><spanclass="o">-</span><spanclass="n">client</span><spanclass="o">-</span><spanclass="n">connections</span><spanclass="o">.</span><spanclass="n">a</span>
200+
<spanclass="n">libcppnetlib</span><spanclass="o">-</span><spanclass="n">server</span><spanclass="o">-</span><spanclass="n">parsers</span><spanclass="o">.</span><spanclass="n">a</span>
201+
<spanclass="n">libcppnetlib</span><spanclass="o">-</span><spanclass="n">uri</span><spanclass="o">.</span><spanclass="n">a</span>
202+
</pre></div>
203+
</div>
204+
<p>And using Visual C++ on Windows they are:</p>
205+
<divclass="highlight-python"><divclass="highlight"><pre><spanclass="n">cppnetlib</span><spanclass="o">-</span><spanclass="n">client</span><spanclass="o">-</span><spanclass="n">connections</span><spanclass="o">.</span><spanclass="n">lib</span>
206+
<spanclass="n">cppnetlib</span><spanclass="o">-</span><spanclass="n">server</span><spanclass="o">-</span><spanclass="n">parsers</span><spanclass="o">.</span><spanclass="n">lib</span>
207+
<spanclass="n">cppnetlib</span><spanclass="o">-</span><spanclass="n">uri</span><spanclass="o">.</span><spanclass="n">lib</span>
208+
</pre></div>
209+
</div>
210+
<pclass="last">Users can find them in<ttclass="docutils literal"><spanclass="pre">~/cpp-netlib-build/libs/network/src</span></tt>.</p>
211+
</div>
187212
</div>
188213
</div>
189214
<divclass="section"id="reporting-issues-getting-support">

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ <h1><a href="#">cpp-netlib v0.9.3 documentation</a></h1>
5858

5959
<divclass="section"id="c-network-library">
6060
<h1>C++ Network Library<aclass="headerlink"href="#c-network-library"title="Permalink to this headline"></a></h1>
61-
<imgalt="_images/boost.png"class="align-right"src="_images/boost.png"/>
61+
<imgalt="_images/boost1.png"class="align-right"src="_images/boost1.png"/>
6262
<divclass="section"id="welcome">
6363
<h2>Welcome<aclass="headerlink"href="#welcome"title="Permalink to this headline"></a></h2>
6464
<p>The<ttclass="xref py py-mod docutils literal"><spanclass="pre">cpp-netlib</span></tt> is a library that provides application layer

‎libs/network/doc/html/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎libs/network/doc/html/twitter_search.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ <h1><a href="index.html">cpp-netlib v0.9.3 documentation</a></h1>
5252
|
5353
<ahref="examples.html"title="Examples"accesskey="U">up</a>
5454
|
55-
<ahref="in_depth.html"title="An in-depth look at the &lt;tt class=&#34;docutils literal docutils literal docutils literal docutils literal docutils literal&#34;&gt;&lt;span class=&#34;pre&#34;&gt;cpp-netlib&lt;/span&gt;&lt;/tt&gt;">next</a> &raquo;</div>
55+
<ahref="in_depth.html"title="An in-depth look at the &lt;tt class=&#34;docutils literal docutils literal docutils literal&#34;&gt;&lt;span class=&#34;pre&#34;&gt;cpp-netlib&lt;/span&gt;&lt;/tt&gt;">next</a> &raquo;</div>
5656
</div>
5757

5858
<divid="bd">
@@ -185,7 +185,7 @@ <h3>Browse</h3>
185185
<li>Prev:<ahref="atom_reader.html">Atom reader</a></li>
186186

187187

188-
<li>Next:<ahref="in_depth.html">An in-depth look at the<ttclass="docutils literal docutils literal docutils literal docutils literal docutils literal"><spanclass="pre">cpp-netlib</span></tt></a></li>
188+
<li>Next:<ahref="in_depth.html">An in-depth look at the<ttclass="docutils literal docutils literal docutils literal"><spanclass="pre">cpp-netlib</span></tt></a></li>
189189

190190
</ul>
191191
<h3>You are here:</h3>
@@ -232,7 +232,7 @@ <h3>Quick search</h3>
232232
|
233233
<ahref="examples.html"title="Examples"accesskey="U">up</a>
234234
|
235-
<ahref="in_depth.html"title="An in-depth look at the &lt;tt class=&#34;docutils literal docutils literal docutils literal docutils literal docutils literal&#34;&gt;&lt;span class=&#34;pre&#34;&gt;cpp-netlib&lt;/span&gt;&lt;/tt&gt;">next</a> &raquo;</div>
235+
<ahref="in_depth.html"title="An in-depth look at the &lt;tt class=&#34;docutils literal docutils literal docutils literal&#34;&gt;&lt;span class=&#34;pre&#34;&gt;cpp-netlib&lt;/span&gt;&lt;/tt&gt;">next</a> &raquo;</div>
236236
</div>
237237
</div>
238238

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp