From bb14a44c2f6f67d6c83eab7121a4e153d09e9c94 Mon Sep 17 00:00:00 2001 From: Daniel Thayer Date: Tue, 22 Oct 2013 12:08:19 -0500 Subject: [PATCH] Make RFC links in the docs more consistent --- src/analyzer/protocol/http/functions.bif | 10 +++++----- src/analyzer/protocol/login/events.bif | 6 ++---- src/analyzer/protocol/netbios/events.bif | 16 ++++++++-------- src/analyzer/protocol/ssl/events.bif | 2 +- 4 files changed, 16 insertions(+), 18 deletions(-) diff --git a/src/analyzer/protocol/http/functions.bif b/src/analyzer/protocol/http/functions.bif index c4e5df80d5..6db5e8b862 100644 --- a/src/analyzer/protocol/http/functions.bif +++ b/src/analyzer/protocol/http/functions.bif @@ -42,11 +42,11 @@ function skip_http_entity_data%(c: connection, is_orig: bool%): any ## ## .. note:: ## -## Unescaping reserved characters may cause loss of information. RFC 2396: -## A URI is always in an "escaped" form, since escaping or unescaping a -## completed URI might change its semantics. Normally, the only time -## escape encodings can safely be made is when the URI is being created -## from its component parts. +## Unescaping reserved characters may cause loss of information. +## :rfc:`2396`: A URI is always in an "escaped" form, since escaping or +## unescaping a completed URI might change its semantics. Normally, the +## only time escape encodings can safely be made is when the URI is +## being created from its component parts. function unescape_URI%(URI: string%): string %{ const u_char* line = URI->Bytes(); diff --git a/src/analyzer/protocol/login/events.bif b/src/analyzer/protocol/login/events.bif index 68f1c3cf11..91c58f21c4 100644 --- a/src/analyzer/protocol/login/events.bif +++ b/src/analyzer/protocol/login/events.bif @@ -1,7 +1,6 @@ ## Generated for client side commands on an RSH connection. ## -## See `RFC 1258 `__ for more information -## about the Rlogin/Rsh protocol. +## See :rfc:`1258` for more information about the Rlogin/Rsh protocol. ## ## 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. ## -## See `RFC 1258 `__ for more information -## about the Rlogin/Rsh protocol. +## See :rfc:`1258` for more information about the Rlogin/Rsh protocol. ## ## c: The connection. ## diff --git a/src/analyzer/protocol/netbios/events.bif b/src/analyzer/protocol/netbios/events.bif index bf382e1663..72933f1e49 100644 --- a/src/analyzer/protocol/netbios/events.bif +++ b/src/analyzer/protocol/netbios/events.bif @@ -3,7 +3,7 @@ ## its name!) the NetBIOS datagram service on UDP port 138. ## ## See `Wikipedia `__ for more information -## about NetBIOS. `RFC 1002 `__ describes +## about NetBIOS. :rfc:`1002` describes ## 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 @@ -12,7 +12,7 @@ ## 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 -## `RFC 1002 `__. +## :rfc:`1002`. ## ## 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. ## ## See `Wikipedia `__ for more information -## about NetBIOS. `RFC 1002 `__ describes +## about NetBIOS. :rfc:`1002` describes ## 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 @@ -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. ## ## See `Wikipedia `__ for more information -## about NetBIOS. `RFC 1002 `__ describes +## about NetBIOS. :rfc:`1002` describes ## 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 @@ -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. ## ## See `Wikipedia `__ for more information -## about NetBIOS. `RFC 1002 `__ describes +## about NetBIOS. :rfc:`1002` describes ## 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 @@ -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. ## ## See `Wikipedia `__ for more information -## about NetBIOS. `RFC 1002 `__ describes +## about NetBIOS. :rfc:`1002` describes ## 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 @@ -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. ## ## See `Wikipedia `__ for more information -## about NetBIOS. `RFC 1002 `__ describes +## about NetBIOS. :rfc:`1002` describes ## 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 @@ -184,7 +184,7 @@ event netbios_session_ret_arg_resp%(c: connection, msg: string%); ## its name!) the NetBIOS datagram service on UDP port 138. ## ## See `Wikipedia `__ for more information -## about NetBIOS. `RFC 1002 `__ describes +## about NetBIOS. :rfc:`1002` describes ## 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 diff --git a/src/analyzer/protocol/ssl/events.bif b/src/analyzer/protocol/ssl/events.bif index 56e5ef59c0..b673954e53 100644 --- a/src/analyzer/protocol/ssl/events.bif +++ b/src/analyzer/protocol/ssl/events.bif @@ -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 ## 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 -## mechanism is described in :rfc:`4507` +## mechanism is described in :rfc:`4507`. ## ## See `Wikipedia `__ for ## more information about the SSL/TLS protocol.