From 2502d09d86df110cafdf830097de6a095929ced2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 7 Oct 2019 13:50:21 +0200 Subject: Fix xref links in manual pages --- _build/Makefile | 6 +++--- docs/en/cowboy/2.2/manual/cowboy_stream/index.html | 18 +++++++++--------- docs/en/cowboy/2.3/manual/cowboy_stream/index.html | 18 +++++++++--------- docs/en/cowboy/2.4/manual/cowboy_stream/index.html | 18 +++++++++--------- docs/en/cowboy/2.5/manual/cowboy_stream/index.html | 18 +++++++++--------- docs/en/cowboy/2.6/guide/specs.asciidoc | 7 ------- docs/en/cowboy/2.6/guide/specs/index.html | 14 -------------- docs/en/cowboy/2.6/manual/cowboy.start_tls/index.html | 4 ++-- docs/en/cowboy/2.6/manual/cowboy_req.cert/index.html | 2 +- docs/en/cowboy/2.6/manual/cowboy_stream/index.html | 6 +++--- 10 files changed, 45 insertions(+), 66 deletions(-) diff --git a/_build/Makefile b/_build/Makefile index 81ad0e02..8d28e443 100644 --- a/_build/Makefile +++ b/_build/Makefile @@ -74,7 +74,7 @@ docs-$1-$2: tmp/$1 "project = \"$1\"" "version = \"$3\"" "doctype = \"manual\"" "+++" "" \ > content/docs/en/$1/$3/manual.asciidoc; \ if [ "$1" = "cowboy" -o "$1" = "gun" -o "$1" = "cowlib" ] || [ "$1" = "ranch" -a "$3" = "1.6" ] || [ "$1" = "ranch" -a "$3" = "1.7" ] || [ "$1" = "ranch" -a "$3" = "2.0" ]; then \ - sed '1,/^$$$$/d' tmp/$1/doc/src/manual/$1_app.asciidoc | sed 's/xref:/link:..\//' \ + sed '1,/^$$$$/d' tmp/$1/doc/src/manual/$1_app.asciidoc \ | sed 's/link:man:\([a-z0-9_]*\)(7)/link:\1_app/g' \ | sed 's/\(link:man:[a-z0-9_]*\):/\1./g' \ | sed 's/link:man:\([a-z0-9_.]*\)[1-9()]*/link:\1/g' \ @@ -95,13 +95,13 @@ docs-$1-$2: tmp/$1 echo "+++" >> content/docs/en/$1/$3/manual/`basename $$$$f`; \ echo >> content/docs/en/$1/$3/manual/`basename $$$$f`; \ if [ "$1" = "cowboy" -o "$1" = "gun" -o "$1" = "cowlib" ] || [ "$1" = "ranch" -a "$3" = "1.6" ] || [ "$1" = "ranch" -a "$3" = "1.7" ] || [ "$1" = "ranch" -a "$3" = "2.0" ]; then \ - sed '1,/^$$$$/d' $$$$f | sed 's/xref:/link:..\//g' \ + sed '1,/^$$$$/d' $$$$f \ | sed 's/link:man:$1(7)/link:../g' \ | sed 's/\(link:man:[a-z0-9_]*\):/\1./g' \ | sed 's/link:man:\([a-z0-9_.]*\)[1-9()]*/link:..\/\1/g' \ >> content/docs/en/$1/$3/manual/`basename $$$$f`; \ else \ - sed '1,/^$$$$/d' $$$$f | sed 's/xref:/link:..\//g' \ + sed '1,/^$$$$/d' $$$$f \ | sed 's/link:man:$1(7)/link:..\/$1_app/g' \ | sed 's/\(link:man:[a-z0-9_]*\):/\1./g' \ | sed 's/link:man:\([a-z0-9_.]*\)[1-9()]*/link:..\/\1/g' \ diff --git a/docs/en/cowboy/2.2/manual/cowboy_stream/index.html b/docs/en/cowboy/2.2/manual/cowboy_stream/index.html index 0c0e64f5..217768fb 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_stream/index.html @@ -251,25 +251,25 @@ http://www.gnu.org/software/src-highlite -->

inform

-

Same as the inform command.

+

Same as the inform command.

Sent when the request process reads the body and an expect: 100-continue header was present in the request, or when the request process sends an informational response on its own.

response

-

Same as the response command.

+

Same as the response command.

Usually sent when the request process replies to the client. May also be sent by Cowboy internally.

headers

-

Same as the headers command.

+

Same as the headers command.

Sent when the request process starts replying to the client.

data

-

Same as the data command.

+

Same as the data command.

Sent when the request process streams data to the client.

trailers

-

Same as the trailers command.

+

Same as the trailers command.

Sent when the request process sends the trailer field values to the client.

push

-

Same as the push command.

+

Same as the push command.

Sent when the request process pushes a resource to the client.

switch_protocol

-

Same as the switch_protocol command.

+

Same as the switch_protocol command.

Sent when switching to the HTTP/2 or Websocket protocol.

Exports

@@ -293,7 +293,7 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> 
commands() :: [Command]
-

See the list of commands for details.

+

See the list of commands for details.

fin()

resp_command() :: {response, cowboy:http_status(),
     cowboy:http_headers(), cowboy_req:resp_body()}
-

See the response command for details.

+

See the response command for details.

streamid()

inform

-

Same as the inform command.

+

Same as the inform command.

Sent when the request process reads the body and an expect: 100-continue header was present in the request, or when the request process sends an informational response on its own.

response

-

Same as the response command.

+

Same as the response command.

Usually sent when the request process replies to the client. May also be sent by Cowboy internally.

headers

-

Same as the headers command.

+

Same as the headers command.

Sent when the request process starts replying to the client.

data

-

Same as the data command.

+

Same as the data command.

Sent when the request process streams data to the client.

trailers

-

Same as the trailers command.

+

Same as the trailers command.

Sent when the request process sends the trailer field values to the client.

push

-

Same as the push command.

+

Same as the push command.

Sent when the request process pushes a resource to the client.

switch_protocol

-

Same as the switch_protocol command.

+

Same as the switch_protocol command.

Sent when switching to the HTTP/2 or Websocket protocol.

Exports

@@ -293,7 +293,7 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> 
commands() :: [Command]
-

See the list of commands for details.

+

See the list of commands for details.

fin()

resp_command() :: {response, cowboy:http_status(),
     cowboy:http_headers(), cowboy_req:resp_body()}
-

See the response command for details.

+

See the response command for details.

streamid()

inform

-

Same as the inform command.

+

Same as the inform command.

Sent when the request process reads the body and an expect: 100-continue header was present in the request, or when the request process sends an informational response on its own.

response

-

Same as the response command.

+

Same as the response command.

Usually sent when the request process replies to the client. May also be sent by Cowboy internally.

headers

-

Same as the headers command.

+

Same as the headers command.

Sent when the request process starts replying to the client.

data

-

Same as the data command.

+

Same as the data command.

Sent when the request process streams data to the client.

trailers

-

Same as the trailers command.

+

Same as the trailers command.

Sent when the request process sends the trailer field values to the client.

push

-

Same as the push command.

+

Same as the push command.

Sent when the request process pushes a resource to the client.

switch_protocol

-

Same as the switch_protocol command.

+

Same as the switch_protocol command.

Sent when switching to the HTTP/2 or Websocket protocol.

Exports

The following function should be called by modules implementing stream handlers to execute the next stream handler in the list:

@@ -292,7 +292,7 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> 
commands() :: [Command]
-

See the list of commands for details.

+

See the list of commands for details.

fin()

resp_command() :: {response, cowboy:http_status(),
     cowboy:http_headers(), cowboy_req:resp_body()}
-

See the response command for details.

+

See the response command for details.

streamid()

inform

-

Same as the inform command.

+

Same as the inform command.

Sent when the request process reads the body and an expect: 100-continue header was present in the request, or when the request process sends an informational response on its own.

response

-

Same as the response command.

+

Same as the response command.

Usually sent when the request process replies to the client. May also be sent by Cowboy internally.

headers

-

Same as the headers command.

+

Same as the headers command.

Sent when the request process starts replying to the client.

data

-

Same as the data command.

+

Same as the data command.

Sent when the request process streams data to the client.

trailers

-

Same as the trailers command.

+

Same as the trailers command.

Sent when the request process sends the trailer field values to the client.

push

-

Same as the push command.

+

Same as the push command.

Sent when the request process pushes a resource to the client.

switch_protocol

-

Same as the switch_protocol command.

+

Same as the switch_protocol command.

Sent when switching to the HTTP/2 or Websocket protocol.

Exports

The following function should be called by modules implementing stream handlers to execute the next stream handler in the list:

@@ -279,7 +279,7 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> 
commands() :: [Command]
-

See the list of commands for details.

+

See the list of commands for details.

fin()

resp_command() :: {response, cowboy:http_status(),
     cowboy:http_headers(), cowboy_req:resp_body()}
-

See the response command for details.

+

See the response command for details.

streamid()

{ok, _} = cowboy:start_tls(example, [ {port, 8443}, - {certfile, "path/to/cert.pem"} + {cert, "path/to/cert.pem"} ], #{ env => #{dispatch => Dispatch} }). @@ -128,7 +128,7 @@ http://www.gnu.org/software/src-highlite --> 
Name = example,
 
 {ok, _} = cowboy:start_tls(Name, [
-    {certfile, "path/to/cert.pem"}
+    {cert, "path/to/cert.pem"}
 ], #{
     env => #{dispatch => Dispatch}
 }),
diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.cert/index.html
index 49209ca7..ba451d7c 100644
--- a/docs/en/cowboy/2.6/manual/cowboy_req.cert/index.html
+++ b/docs/en/cowboy/2.6/manual/cowboy_req.cert/index.html
@@ -79,7 +79,7 @@ http://www.lorenzobettini.it
 http://www.gnu.org/software/src-highlite -->
 
{ok, _} = cowboy:start_tls(example, [
     {port, 8443},
-    {certfile, "path/to/cert.pem"},
+    {cert, "path/to/cert.pem"},
     {verify, verify_peer}
 ], #{
     env => #{dispatch => Dispatch}
diff --git a/docs/en/cowboy/2.6/manual/cowboy_stream/index.html b/docs/en/cowboy/2.6/manual/cowboy_stream/index.html
index 85938072..a10e6e62 100644
--- a/docs/en/cowboy/2.6/manual/cowboy_stream/index.html
+++ b/docs/en/cowboy/2.6/manual/cowboy_stream/index.html
@@ -220,7 +220,7 @@ http://www.gnu.org/software/src-highlite -->
 
Cowboy will forward all messages sent to the stream to the info/3 callback. To send a message to a stream, send a message to the connection process with the form {{Pid, StreamID}, Msg}. The connection process will then forward Msg to the stream handlers.

 
Cowboy will also forward the exit signals for the processes that the stream spawned.

 
When Cowboy needs to send a response it will trigger an event that looks exactly like the corresponding command. This event must be returned to be processed by Cowboy (which is done automatically when using cowboy_stream_h(3)).

-
Cowboy may trigger the following events on its own, regardless of the stream handlers configured: inform (to send a 101 informational response when upgrading to HTTP/2 or Websocket), response, headers, data and switch_protocol.

+
Cowboy may trigger the following events on its own, regardless of the stream handlers configured: inform (to send a 101 informational response when upgrading to HTTP/2 or Websocket), response, headers, data and switch_protocol.

 
Exports

 
The following function should be called by modules implementing stream handlers to execute the next stream handler in the list:

 
  • cowboy_stream:init(3) - Initialize a stream
@@ -242,7 +242,7 @@ http://www.lorenzobettini.it
 http://www.gnu.org/software/src-highlite -->
 
    commands() :: [Command]
-

See the list of commands for details.

+

See the list of commands for details.

fin()

resp_command() :: {response, cowboy:http_status(),
     cowboy:http_headers(), cowboy_req:resp_body()}
-

See the response command for details.

+

See the response command for details.

streamid()