Make RFC links in the docs more consistent

This commit is contained in:
Daniel Thayer 2013-10-22 12:08:19 -05:00
parent f5d6931f00
commit bb14a44c2f
4 changed files with 16 additions and 18 deletions

View file

@ -42,11 +42,11 @@ function skip_http_entity_data%(c: connection, is_orig: bool%): any
## ##
## .. note:: ## .. note::
## ##
## Unescaping reserved characters may cause loss of information. RFC 2396: ## Unescaping reserved characters may cause loss of information.
## A URI is always in an "escaped" form, since escaping or unescaping a ## :rfc:`2396`: A URI is always in an "escaped" form, since escaping or
## completed URI might change its semantics. Normally, the only time ## unescaping a completed URI might change its semantics. Normally, the
## escape encodings can safely be made is when the URI is being created ## only time escape encodings can safely be made is when the URI is
## from its component parts. ## being created from its component parts.
function unescape_URI%(URI: string%): string function unescape_URI%(URI: string%): string
%{ %{
const u_char* line = URI->Bytes(); const u_char* line = URI->Bytes();

View file

@ -1,7 +1,6 @@
## Generated for client side commands on an RSH connection. ## Generated for client side commands on an RSH connection.
## ##
## See `RFC 1258 <http://tools.ietf.org/html/rfc1258>`__ for more information ## See :rfc:`1258` for more information about the Rlogin/Rsh protocol.
## about the Rlogin/Rsh protocol.
## ##
## c: The connection. ## c: The connection.
## ##
@ -30,8 +29,7 @@ event rsh_request%(c: connection, client_user: string, server_user: string, line
## Generated for client side commands on an RSH connection. ## Generated for client side commands on an RSH connection.
## ##
## See `RFC 1258 <http://tools.ietf.org/html/rfc1258>`__ for more information ## See :rfc:`1258` for more information about the Rlogin/Rsh protocol.
## about the Rlogin/Rsh protocol.
## ##
## c: The connection. ## c: The connection.
## ##

View file

@ -3,7 +3,7 @@
## its name!) the NetBIOS datagram service on UDP port 138. ## its name!) the NetBIOS datagram service on UDP port 138.
## ##
## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information ## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information
## about NetBIOS. `RFC 1002 <http://tools.ietf.org/html/rfc1002>`__ describes ## about NetBIOS. :rfc:`1002` describes
## the packet format for NetBIOS over TCP/IP, which Bro parses. ## the packet format for NetBIOS over TCP/IP, which Bro parses.
## ##
## c: The connection, which may be TCP or UDP, depending on the type of the ## c: The connection, which may be TCP or UDP, depending on the type of the
@ -12,7 +12,7 @@
## is_orig: True if the message was sent by the originator of the connection. ## is_orig: True if the message was sent by the originator of the connection.
## ##
## msg_type: The general type of message, as defined in Section 4.3.1 of ## msg_type: The general type of message, as defined in Section 4.3.1 of
## `RFC 1002 <http://tools.ietf.org/html/rfc1002>`__. ## :rfc:`1002`.
## ##
## data_len: The length of the message's payload. ## data_len: The length of the message's payload.
## ##
@ -35,7 +35,7 @@ event netbios_session_message%(c: connection, is_orig: bool, msg_type: count, da
## (despite its name!) the NetBIOS datagram service on UDP port 138. ## (despite its name!) the NetBIOS datagram service on UDP port 138.
## ##
## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information ## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information
## about NetBIOS. `RFC 1002 <http://tools.ietf.org/html/rfc1002>`__ describes ## about NetBIOS. :rfc:`1002` describes
## the packet format for NetBIOS over TCP/IP, which Bro parses. ## the packet format for NetBIOS over TCP/IP, which Bro parses.
## ##
## c: The connection, which may be TCP or UDP, depending on the type of the ## c: The connection, which may be TCP or UDP, depending on the type of the
@ -63,7 +63,7 @@ event netbios_session_request%(c: connection, msg: string%);
## 139, and (despite its name!) the NetBIOS datagram service on UDP port 138. ## 139, and (despite its name!) the NetBIOS datagram service on UDP port 138.
## ##
## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information ## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information
## about NetBIOS. `RFC 1002 <http://tools.ietf.org/html/rfc1002>`__ describes ## about NetBIOS. :rfc:`1002` describes
## the packet format for NetBIOS over TCP/IP, which Bro parses. ## the packet format for NetBIOS over TCP/IP, which Bro parses.
## ##
## c: The connection, which may be TCP or UDP, depending on the type of the ## c: The connection, which may be TCP or UDP, depending on the type of the
@ -91,7 +91,7 @@ event netbios_session_accepted%(c: connection, msg: string%);
## 139, and (despite its name!) the NetBIOS datagram service on UDP port 138. ## 139, and (despite its name!) the NetBIOS datagram service on UDP port 138.
## ##
## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information ## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information
## about NetBIOS. `RFC 1002 <http://tools.ietf.org/html/rfc1002>`__ describes ## about NetBIOS. :rfc:`1002` describes
## the packet format for NetBIOS over TCP/IP, which Bro parses. ## the packet format for NetBIOS over TCP/IP, which Bro parses.
## ##
## c: The connection, which may be TCP or UDP, depending on the type of the ## c: The connection, which may be TCP or UDP, depending on the type of the
@ -121,7 +121,7 @@ event netbios_session_rejected%(c: connection, msg: string%);
## 139, and (despite its name!) the NetBIOS datagram service on UDP port 138. ## 139, and (despite its name!) the NetBIOS datagram service on UDP port 138.
## ##
## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information ## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information
## about NetBIOS. `RFC 1002 <http://tools.ietf.org/html/rfc1002>`__ describes ## about NetBIOS. :rfc:`1002` describes
## the packet format for NetBIOS over TCP/IP, which Bro parses. ## the packet format for NetBIOS over TCP/IP, which Bro parses.
## ##
## c: The connection, which may be TCP or UDP, depending on the type of the ## c: The connection, which may be TCP or UDP, depending on the type of the
@ -154,7 +154,7 @@ event netbios_session_raw_message%(c: connection, is_orig: bool, msg: string%);
## (despite its name!) the NetBIOS datagram service on UDP port 138. ## (despite its name!) the NetBIOS datagram service on UDP port 138.
## ##
## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information ## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information
## about NetBIOS. `RFC 1002 <http://tools.ietf.org/html/rfc1002>`__ describes ## about NetBIOS. :rfc:`1002` describes
## the packet format for NetBIOS over TCP/IP, which Bro parses. ## the packet format for NetBIOS over TCP/IP, which Bro parses.
## ##
## c: The connection, which may be TCP or UDP, depending on the type of the ## c: The connection, which may be TCP or UDP, depending on the type of the
@ -184,7 +184,7 @@ event netbios_session_ret_arg_resp%(c: connection, msg: string%);
## its name!) the NetBIOS datagram service on UDP port 138. ## its name!) the NetBIOS datagram service on UDP port 138.
## ##
## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information ## See `Wikipedia <http://en.wikipedia.org/wiki/NetBIOS>`__ for more information
## about NetBIOS. `RFC 1002 <http://tools.ietf.org/html/rfc1002>`__ describes ## about NetBIOS. :rfc:`1002` describes
## the packet format for NetBIOS over TCP/IP, which Bro parses. ## the packet format for NetBIOS over TCP/IP, which Bro parses.
## ##
## c: The connection, which may be TCP or UDP, depending on the type of the ## c: The connection, which may be TCP or UDP, depending on the type of the

View file

@ -123,7 +123,7 @@ event ssl_alert%(c: connection, is_orig: bool, level: count, desc: count%);
## an unencrypted handshake, and Bro extracts as much information out of that ## an unencrypted handshake, and Bro extracts as much information out of that
## as it can. This event is raised when an SSL/TLS server passes a session ## as it can. This event is raised when an SSL/TLS server passes a session
## ticket to the client that can later be used for resuming the session. The ## ticket to the client that can later be used for resuming the session. The
## mechanism is described in :rfc:`4507` ## mechanism is described in :rfc:`4507`.
## ##
## See `Wikipedia <http://en.wikipedia.org/wiki/Transport_Layer_Security>`__ for ## See `Wikipedia <http://en.wikipedia.org/wiki/Transport_Layer_Security>`__ for
## more information about the SSL/TLS protocol. ## more information about the SSL/TLS protocol.