Update doc

apiref.html

@@ -2541,6 +2541,11 @@ HEADERS have END_STREAM set.  The <em>stream_user_data</em> is data
 associated to the stream opened by this request and can be an
 arbitrary pointer, which can be retrieved later by
 <a class="reference internal" href="#c.nghttp2_session_get_stream_user_data" title="nghttp2_session_get_stream_user_data"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_get_stream_user_data()</span></tt></a>.</p>
+<p>This function returns assigned stream ID if it succeeds.  But that
+stream is not opened yet.  The application must not submit frame to
+that stream ID before
+<a class="reference internal" href="#c.nghttp2_session_callbacks.before_frame_send_callback" title="nghttp2_session_callbacks.before_frame_send_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.before_frame_send_callback</span></tt></a> is
+called for this frame.</p>
 <p>This function returns assigned stream ID if it succeeds, or one of
 the following negative error codes:</p>
 <dl class="docutils">
@@ -2627,6 +2632,11 @@ stream state from idle or reserved to open.</p>
 <p>This function is low-level in a sense that the application code can
 specify flags directly.  For usual HTTP request,
 <a class="reference internal" href="#c.nghttp2_submit_request" title="nghttp2_submit_request"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_request()</span></tt></a> is useful.</p>
+<p>This function returns assigned stream ID if it succeeds and
+<em>stream_id</em> is -1.  But that stream is not opened yet.  The
+application must not submit frame to that stream ID before
+<a class="reference internal" href="#c.nghttp2_session_callbacks.before_frame_send_callback" title="nghttp2_session_callbacks.before_frame_send_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.before_frame_send_callback</span></tt></a> is
+called for this frame.</p>
 <p>This function returns newly assigned stream ID if it succeeds and
 <em>stream_id</em> is -1.  Otherwise, this function returns 0 if it
 succeeds, or one of the following negative error codes:</p>
@@ -2752,6 +2762,11 @@ make it in reserved state.  It is available using
 <a class="reference internal" href="#c.nghttp2_session_get_stream_user_data" title="nghttp2_session_get_stream_user_data"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_get_stream_user_data()</span></tt></a>.  The application can
 access it in <a class="reference internal" href="#c.nghttp2_before_frame_send_callback" title="nghttp2_before_frame_send_callback"><tt class="xref c c-type docutils literal"><span class="pre">nghttp2_before_frame_send_callback</span></tt></a> and
 <a class="reference internal" href="#c.nghttp2_on_frame_send_callback" title="nghttp2_on_frame_send_callback"><tt class="xref c c-type docutils literal"><span class="pre">nghttp2_on_frame_send_callback</span></tt></a> of this frame.</p>
+<p>This function returns assigned promised stream ID if it succeeds.
+But that stream is not opened yet.  The application must not submit
+frame to that stream ID before
+<a class="reference internal" href="#c.nghttp2_session_callbacks.before_frame_send_callback" title="nghttp2_session_callbacks.before_frame_send_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.before_frame_send_callback</span></tt></a> is
+called for this frame.</p>
 <p>The client side is not allowed to use this function.</p>
 <p>This function returns assigned promised stream ID if it succeeds,
 or one of the following negative error codes:</p>

nghttp2.h.html

@@ -2335,6 +2335,12 @@
 <span class="cm"> * arbitrary pointer, which can be retrieved later by</span>
 <span class="cm"> * `nghttp2_session_get_stream_user_data()`.</span>
 <span class="cm"> *</span>
+<span class="cm"> * This function returns assigned stream ID if it succeeds.  But that</span>
+<span class="cm"> * stream is not opened yet.  The application must not submit frame to</span>
+<span class="cm"> * that stream ID before</span>
+<span class="cm"> * :member:`nghttp2_session_callbacks.before_frame_send_callback` is</span>
+<span class="cm"> * called for this frame.</span>
+<span class="cm"> *</span>
 <span class="cm"> * This function returns assigned stream ID if it succeeds, or one of</span>
 <span class="cm"> * the following negative error codes:</span>
 <span class="cm"> *</span>
@@ -2443,6 +2449,12 @@
 <span class="cm"> * specify flags directly.  For usual HTTP request,</span>
 <span class="cm"> * `nghttp2_submit_request()` is useful.</span>
 <span class="cm"> *</span>
+<span class="cm"> * This function returns assigned stream ID if it succeeds and</span>
+<span class="cm"> * |stream_id| is -1.  But that stream is not opened yet.  The</span>
+<span class="cm"> * application must not submit frame to that stream ID before</span>
+<span class="cm"> * :member:`nghttp2_session_callbacks.before_frame_send_callback` is</span>
+<span class="cm"> * called for this frame.</span>
+<span class="cm"> *</span>
 <span class="cm"> * This function returns newly assigned stream ID if it succeeds and</span>
 <span class="cm"> * |stream_id| is -1.  Otherwise, this function returns 0 if it</span>
 <span class="cm"> * succeeds, or one of the following negative error codes:</span>
@@ -2599,6 +2611,12 @@
 <span class="cm"> * access it in :type:`nghttp2_before_frame_send_callback` and</span>
 <span class="cm"> * :type:`nghttp2_on_frame_send_callback` of this frame.</span>
 <span class="cm"> *</span>
+<span class="cm"> * This function returns assigned promised stream ID if it succeeds.</span>
+<span class="cm"> * But that stream is not opened yet.  The application must not submit</span>
+<span class="cm"> * frame to that stream ID before</span>
+<span class="cm"> * :member:`nghttp2_session_callbacks.before_frame_send_callback` is</span>
+<span class="cm"> * called for this frame.</span>
+<span class="cm"> *</span>
 <span class="cm"> * The client side is not allowed to use this function.</span>
 <span class="cm"> *</span>
 <span class="cm"> * This function returns assigned promised stream ID if it succeeds,</span>

package_README.html

@@ -178,8 +178,9 @@ header compression
 <p>The following endpoints are available to try out nghttp2
 implementation.</p>
 <ul>
-<li><p class="first"><a class="reference external" href="https://nghttp2.org/">https://nghttp2.org/</a> (TLS + NPN / ALPN)</p>
+<li><p class="first"><a class="reference external" href="https://nghttp2.org/">https://nghttp2.org/</a> (TLS + NPN)</p>
-<p>ALPN and NPN offer <tt class="docutils literal"><span class="pre">h2-12</span></tt>, <tt class="docutils literal"><span class="pre">spdy/3.1</span></tt> and <tt class="docutils literal"><span class="pre">http/1.1</span></tt>.</p>
+<p>NPN offer <tt class="docutils literal"><span class="pre">h2-12</span></tt>, <tt class="docutils literal"><span class="pre">spdy/3.1</span></tt> and <tt class="docutils literal"><span class="pre">http/1.1</span></tt>.
+ALPN is currently disabled.</p>
 </li>
 <li><p class="first"><a class="reference external" href="http://nghttp2.org/">http://nghttp2.org/</a> (Upgrade / Direct)</p>
 <p><tt class="docutils literal"><span class="pre">h2c-12</span></tt> and <tt class="docutils literal"><span class="pre">http/1.1</span></tt>.  We configured this server to send
@@ -268,10 +269,13 @@ $ ./configure
 $ make
 </pre></div>
 </div>
-<p>Mac OS X users may need <tt class="docutils literal"><span class="pre">--disable-threads</span></tt> configure option to
+<div class="admonition note">
-disable multi threading in nghttpd, nghttpx and h2load to prevent them
+<p class="first admonition-title">Note</p>
-from crashing.  Patch is welcome to make multi threading work on Mac
+<p class="last">Mac OS X users may need <tt class="docutils literal"><span class="pre">--disable-threads</span></tt> configure option to
-OS X platform.</p>
+disable multi threading in nghttpd, nghttpx and h2load to prevent
+them from crashing.  Patch is welcome to make multi threading work
+on Mac OS X platform.</p>
+</div>
 </div>
 <div class="section" id="building-documentation">
 <h2>Building documentation<a class="headerlink" href="#building-documentation" title="Permalink to this headline">¶</a></h2>