Merge remote-tracking branch 'origin/master' into topic/dnthayer/doc-changes-for-2.2

This commit is contained in:
Daniel Thayer 2013-10-11 23:16:57 -05:00
commit 93c1073673
9 changed files with 68 additions and 12 deletions

12
CHANGES
View file

@ -1,4 +1,16 @@
2.2-beta-57 | 2013-10-11 17:23:25 -0700
* Improve Broxygen end-of-sentence detection. (Jon Siwek)
2.2-beta-55 | 2013-10-10 13:36:38 -0700
* A couple of new TLS extension numbers. (Bernhard Amann)
* Suport for three more new TLS ciphers. (Bernhard Amann)
* Removing ICSI notary from default site config. (Robin Sommer)
2.2-beta-51 | 2013-10-07 17:33:56 -0700 2.2-beta-51 | 2013-10-07 17:33:56 -0700
* Polishing the reference and scripting sections of the manual. * Polishing the reference and scripting sections of the manual.

View file

@ -1 +1 @@
2.2-beta-51 2.2-beta-57

@ -1 +1 @@
Subproject commit 7ca51fc46c5c3dd4f3d803e5c617c2e35129fb05 Subproject commit 81fa2d664a7ef7306a03928484b10611fbe893b8

View file

@ -167,6 +167,10 @@ export {
# it's fine if the type is inferred, that information is self-documenting # it's fine if the type is inferred, that information is self-documenting
global var_without_explicit_type = "this works"; global var_without_explicit_type = "this works";
## The first.sentence for the summary text ends here. And this second
## sentence doesn't show in the short description.
global dummy: string;
############## functions/events ############ ############## functions/events ############
## Summarize purpose of "a_function" here. ## Summarize purpose of "a_function" here.

View file

@ -78,6 +78,9 @@ export {
[13] = "signature_algorithms", [13] = "signature_algorithms",
[14] = "use_srtp", [14] = "use_srtp",
[15] = "heartbeat", [15] = "heartbeat",
[16] = "application_layer_protocol_negotiation",
[17] = "status_request_v2",
[18] = "signed_certificate_timestamp",
[35] = "SessionTicket TLS", [35] = "SessionTicket TLS",
[40] = "extended_random", [40] = "extended_random",
[13172] = "next_protocol_negotiation", [13172] = "next_protocol_negotiation",
@ -434,6 +437,10 @@ export {
const TLS_PSK_WITH_AES_256_CCM_8 = 0xC0A9; const TLS_PSK_WITH_AES_256_CCM_8 = 0xC0A9;
const TLS_PSK_DHE_WITH_AES_128_CCM_8 = 0xC0AA; const TLS_PSK_DHE_WITH_AES_128_CCM_8 = 0xC0AA;
const TLS_PSK_DHE_WITH_AES_256_CCM_8 = 0xC0AB; const TLS_PSK_DHE_WITH_AES_256_CCM_8 = 0xC0AB;
# draft-agl-tls-chacha20poly1305-02
const TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 = 0xCC13;
const TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 = 0xCC14;
const TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 = 0xCC15;
const SSL_RSA_FIPS_WITH_DES_CBC_SHA = 0xFEFE; const SSL_RSA_FIPS_WITH_DES_CBC_SHA = 0xFEFE;
const SSL_RSA_FIPS_WITH_3DES_EDE_CBC_SHA = 0xFEFF; const SSL_RSA_FIPS_WITH_3DES_EDE_CBC_SHA = 0xFEFF;
@ -792,6 +799,9 @@ export {
[TLS_PSK_WITH_AES_256_CCM_8] = "TLS_PSK_WITH_AES_256_CCM_8", [TLS_PSK_WITH_AES_256_CCM_8] = "TLS_PSK_WITH_AES_256_CCM_8",
[TLS_PSK_DHE_WITH_AES_128_CCM_8] = "TLS_PSK_DHE_WITH_AES_128_CCM_8", [TLS_PSK_DHE_WITH_AES_128_CCM_8] = "TLS_PSK_DHE_WITH_AES_128_CCM_8",
[TLS_PSK_DHE_WITH_AES_256_CCM_8] = "TLS_PSK_DHE_WITH_AES_256_CCM_8", [TLS_PSK_DHE_WITH_AES_256_CCM_8] = "TLS_PSK_DHE_WITH_AES_256_CCM_8",
[TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256] = "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256",
[TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256] = "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256",
[TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256] = "TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256",
[SSL_RSA_FIPS_WITH_DES_CBC_SHA] = "SSL_RSA_FIPS_WITH_DES_CBC_SHA", [SSL_RSA_FIPS_WITH_DES_CBC_SHA] = "SSL_RSA_FIPS_WITH_DES_CBC_SHA",
[SSL_RSA_FIPS_WITH_3DES_EDE_CBC_SHA] = "SSL_RSA_FIPS_WITH_3DES_EDE_CBC_SHA", [SSL_RSA_FIPS_WITH_3DES_EDE_CBC_SHA] = "SSL_RSA_FIPS_WITH_3DES_EDE_CBC_SHA",
[SSL_RSA_FIPS_WITH_DES_CBC_SHA_2] = "SSL_RSA_FIPS_WITH_DES_CBC_SHA_2", [SSL_RSA_FIPS_WITH_DES_CBC_SHA_2] = "SSL_RSA_FIPS_WITH_DES_CBC_SHA_2",

View file

@ -59,9 +59,9 @@
# This script enables SSL/TLS certificate validation. # This script enables SSL/TLS certificate validation.
@load protocols/ssl/validate-certs @load protocols/ssl/validate-certs
# This script checks each SSL certificate hash against the ICSI certificate # Uncomment the following line to check each SSL certificate hash against the ICSI
# notary service. # certificate notary service; see http://notary.icsi.berkeley.edu .
@load protocols/ssl/notary # @load protocols/ssl/notary
# If you have libGeoIP support built in, do some geographic detections and # If you have libGeoIP support built in, do some geographic detections and
# logging for SSH traffic. # logging for SSH traffic.

View file

@ -74,6 +74,27 @@ int BroDocObj::LongestShortDescLen() const
return max; return max;
} }
static size_t end_of_first_sentence(string s)
{
size_t rval = 0;
while ( (rval = s.find_first_of('.', rval)) != string::npos )
{
if ( rval == s.size() - 1 )
// Period is at end of string.
return rval;
if ( isspace(s[rval + 1]) )
// Period has a space after it.
return rval;
// Period has some non-space character after it, keep looking.
++rval;
}
return rval;
}
void BroDocObj::FormulateShortDesc() void BroDocObj::FormulateShortDesc()
{ {
if ( ! reST_doc_strings ) if ( ! reST_doc_strings )
@ -87,7 +108,7 @@ void BroDocObj::FormulateShortDesc()
{ {
// The short description stops at the first sentence or the // The short description stops at the first sentence or the
// first empty comment. // first empty comment.
size_t end = it->find_first_of("."); size_t end = end_of_first_sentence(*it);
if ( end == string::npos ) if ( end == string::npos )
{ {

View file

@ -20,11 +20,11 @@ Options
Types Types
##### #####
======================================= ====================================== ======================================= ========================================
:bro:type:`TestEnum1`: :bro:type:`enum` There's tons of ways an enum can look. :bro:type:`TestEnum1`: :bro:type:`enum` There's tons of ways an enum can look...
:bro:type:`TestEnum2`: :bro:type:`enum` The final comma is optional :bro:type:`TestEnum2`: :bro:type:`enum` The final comma is optional
======================================= ====================================== ======================================= ========================================
Redefinitions Redefinitions
############# #############

View file

@ -40,13 +40,15 @@ Options
State Variables State Variables
############### ###############
=========================================================================== ======================================= =========================================================================== ==================================================
:bro:id:`Example::a_var`: :bro:type:`bool` put some documentation for "a_var" here :bro:id:`Example::a_var`: :bro:type:`bool` put some documentation for "a_var" here
:bro:id:`Example::var_with_attr`: :bro:type:`count` :bro:attr:`&persistent` :bro:id:`Example::var_with_attr`: :bro:type:`count` :bro:attr:`&persistent`
:bro:id:`Example::var_without_explicit_type`: :bro:type:`string` :bro:id:`Example::var_without_explicit_type`: :bro:type:`string`
=========================================================================== =======================================
:bro:id:`Example::dummy`: :bro:type:`string` The first.sentence for the summary text ends here.
=========================================================================== ==================================================
Types Types
##### #####
@ -156,6 +158,13 @@ State Variables
:Type: :bro:type:`string` :Type: :bro:type:`string`
:Default: ``"this works"`` :Default: ``"this works"``
.. bro:id:: Example::dummy
:Type: :bro:type:`string`
The first.sentence for the summary text ends here. And this second
sentence doesn't show in the short description.
Types Types
##### #####
.. bro:type:: Example::SimpleEnum .. bro:type:: Example::SimpleEnum