~samwhited/xmpp

8ee3bc1f84d3f5a7e907e651253f51eb910b9018 — Sam Whited 1 year, 1 month ago ad06d1a
all: update BUG comments

Remove inaccurate BUG comments and update existing ones to contain a
link to their relavant issue so that they get removed if the issue is
closed.

Signed-off-by: Sam Whited <sam@samwhited.com>
4 files changed, 1 insertions(+), 7 deletions(-)

M internal/marshal/encode.go
M sasl.go
M sasl2/sasl.go
M starttls.go
M internal/marshal/encode.go => internal/marshal/encode.go +1 -1
@@ 13,7 13,7 @@ import (
	"mellium.im/xmlstream"
)

// BUG(ssw): Functions in this package are extremely inefficient.
// BUG(ssw): This package is very inefficient, see https://mellium.im/issue/38.

// TokenReader returns a reader for the XML encoding of v.
func TokenReader(v interface{}) (xml.TokenReader, error) {

M sasl.go => sasl.go +0 -2
@@ 20,8 20,6 @@ import (
	"mellium.im/xmpp/stream"
)

// BUG(ssw): SASL feature does not have security layer byte precision.

// SASL returns a stream feature for performing authentication using the Simple
// Authentication and Security Layer (SASL) as defined in RFC 4422.
// It panics if no mechanisms are specified.

M sasl2/sasl.go => sasl2/sasl.go +0 -2
@@ 26,8 26,6 @@ import (
	"mellium.im/xmpp/stream"
)

// BUG(ssw): feature may provide a security layer, but is not byte precise.

// TODO(ssw): Support caching mechanisms on the feature and pipelining the
// selection.


M starttls.go => starttls.go +0 -2
@@ 16,8 16,6 @@ import (
	"mellium.im/xmpp/stream"
)

// BUG(ssw): STARTTLS feature does not have security layer byte precision.

// StartTLS returns a new stream feature that can be used for negotiating TLS.
// If cfg is nil, a default configuration is used that uses the domainpart of
// the sessions local address as the ServerName.