Update doc

_sources/apiref.txt

@@ -1390,6 +1390,9 @@ Functions
     ``NULL`` in the *stream_user_data*, which nullifies the associated
     data pointer.
     
+    It is valid to set the *stream_user_data* to the stream reserved by
+    PUSH_PROMISE frame.
+    
     This function returns 0 if it succeeds, or one of following
     negative error codes:
     

_sources/index.txt

@@ -17,6 +17,7 @@ Contents:
    :maxdepth: 2
 
    package_README
+   tutorial-client
    apiref
    nghttp2.h
    nghttp2ver.h

apiref.html

@@ -46,7 +46,7 @@
   
     <link rel="top" title="nghttp2 0.3.0-DEV documentation" href="index.html"/>
         <link rel="next" title="nghttp2.h" href="nghttp2.h.html"/>
-        <link rel="prev" title="nghttp2 - HTTP/2.0 C Library" href="package_README.html"/> 
+        <link rel="prev" title="Tutorial: HTTP/2.0 client" href="tutorial-client.html"/> 
 
   <script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
 
@@ -81,6 +81,7 @@
 <li class="toctree-l2"><a class="reference internal" href="package_README.html#header-compression-test-tools">Header compression test tools</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorial-client.html">Tutorial: HTTP/2.0 client</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#includes">Includes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#remarks">Remarks</a></li>
@@ -1936,6 +1937,8 @@ int <tt class="descname">nghttp2_session_set_stream_user_data</tt><big>(</big><a
 is replaced with the <em>stream_user_data</em>. It is valid to specify
 <tt class="docutils literal"><span class="pre">NULL</span></tt> in the <em>stream_user_data</em>, which nullifies the associated
 data pointer.</p>
+<p>It is valid to set the <em>stream_user_data</em> to the stream reserved by
+PUSH_PROMISE frame.</p>
 <p>This function returns 0 if it succeeds, or one of following
 negative error codes:</p>
 <dl class="docutils">
@@ -2552,7 +2555,7 @@ the version checking.</p>
         <a href="nghttp2.h.html" class="btn btn-neutral float-right" title="nghttp2.h"/>Next <span class="icon icon-circle-arrow-right"></span></a>
       
       
-        <a href="package_README.html" class="btn btn-neutral" title="nghttp2 - HTTP/2.0 C Library"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+        <a href="tutorial-client.html" class="btn btn-neutral" title="Tutorial: HTTP/2.0 client"><span class="icon icon-circle-arrow-left"></span> Previous</a>
       
     </div>
   

genindex.html

@@ -81,6 +81,7 @@
 <li class="toctree-l2"><a class="reference internal" href="package_README.html#header-compression-test-tools">Header compression test tools</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorial-client.html">Tutorial: HTTP/2.0 client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apiref.html">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#includes">Includes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#remarks">Remarks</a></li>

index.html

@@ -80,6 +80,7 @@
 <li class="toctree-l2"><a class="reference internal" href="package_README.html#header-compression-test-tools">Header compression test tools</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorial-client.html">Tutorial: HTTP/2.0 client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apiref.html">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#includes">Includes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#remarks">Remarks</a></li>
@@ -142,6 +143,7 @@ version 2.0.</p>
 <li class="toctree-l2"><a class="reference internal" href="package_README.html#header-compression-test-tools">Header compression test tools</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorial-client.html">Tutorial: HTTP/2.0 client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apiref.html">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#includes">Includes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#remarks">Remarks</a></li>

nghttp2.h.html

@@ -81,6 +81,7 @@
 <li class="toctree-l2"><a class="reference internal" href="package_README.html#header-compression-test-tools">Header compression test tools</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorial-client.html">Tutorial: HTTP/2.0 client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apiref.html">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#includes">Includes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#remarks">Remarks</a></li>
@@ -1726,6 +1727,9 @@
 <span class="cm"> * ``NULL`` in the |stream_user_data|, which nullifies the associated</span>
 <span class="cm"> * data pointer.</span>
 <span class="cm"> *</span>
+<span class="cm"> * It is valid to set the |stream_user_data| to the stream reserved by</span>
+<span class="cm"> * PUSH_PROMISE frame.</span>
+<span class="cm"> *</span>
 <span class="cm"> * This function returns 0 if it succeeds, or one of following</span>
 <span class="cm"> * negative error codes:</span>
 <span class="cm"> *</span>

nghttp2ver.h.html

@@ -80,6 +80,7 @@
 <li class="toctree-l2"><a class="reference internal" href="package_README.html#header-compression-test-tools">Header compression test tools</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorial-client.html">Tutorial: HTTP/2.0 client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apiref.html">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#includes">Includes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#remarks">Remarks</a></li>

package_README.html

@@ -45,7 +45,7 @@
 
   
     <link rel="top" title="nghttp2 0.3.0-DEV documentation" href="index.html"/>
-        <link rel="next" title="API Reference" href="apiref.html"/>
+        <link rel="next" title="Tutorial: HTTP/2.0 client" href="tutorial-client.html"/>
         <link rel="prev" title="nghttp2 - HTTP/2.0 C Library" href="index.html"/> 
 
   <script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
@@ -81,6 +81,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#header-compression-test-tools">Header compression test tools</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorial-client.html">Tutorial: HTTP/2.0 client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apiref.html">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#includes">Includes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#remarks">Remarks</a></li>
@@ -866,7 +867,7 @@ corresponding header set was processed. The format is the same as
   
     <div class="rst-footer-buttons">
       
-        <a href="apiref.html" class="btn btn-neutral float-right" title="API Reference"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+        <a href="tutorial-client.html" class="btn btn-neutral float-right" title="Tutorial: HTTP/2.0 client"/>Next <span class="icon icon-circle-arrow-right"></span></a>
       
       
         <a href="index.html" class="btn btn-neutral" title="nghttp2 - HTTP/2.0 C Library"><span class="icon icon-circle-arrow-left"></span> Previous</a>

search.html

@@ -86,6 +86,7 @@
 <li class="toctree-l2"><a class="reference internal" href="package_README.html#header-compression-test-tools">Header compression test tools</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorial-client.html">Tutorial: HTTP/2.0 client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apiref.html">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#includes">Includes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="apiref.html#remarks">Remarks</a></li>