code review 5905048: go.crypto/ssh: fix example in documentation

go.crypto/ssh: fix example in documentation

[fhs, 2012-03-24 17:28:24]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://code.google.com/p/go.crypto

[fhs, 2012-03-25 17:35:32]

Hello golang-dev@googlegroups.com (cc: golang-dev@googlegroups.com),

Please take another look.

[dave_cheney.net, 2012-03-26 11:18:45]

LGTM. Thank you for this. 

If you wanted to go for extra credit you could take a crack at turning these
into example_test.go style examples for Dial and Listen.

http://codereview.appspot.com/5905048/diff/5003/ssh/doc.go
File ssh/doc.go (right):

http://codereview.appspot.com/5905048/diff/5003/ssh/doc.go#newcode122
ssh/doc.go:122: b := new(bytes.Buffer)
var b bytes.Buffer

[fhs, 2012-03-26 18:53:13]

PTAL. I added the example tests.

> If you wanted to go for extra credit you could take a crack at turning these
> into example_test.go style examples for Dial and Listen.

[fhs, 2012-03-26 18:56:31]

Hello golang-dev@googlegroups.com, dave@cheney.net (cc:
golang-dev@googlegroups.com),

Please take another look.

[dave_cheney.net, 2012-03-27 10:28:42]

Thank you very much, I cleaned up a bit of the crufty old example code. Looks
pretty good too me.

http://codereview.appspot.com/5905048/diff/10/ssh/doc.go
File ssh/doc.go (right):

http://codereview.appspot.com/5905048/diff/10/ssh/doc.go#newcode12
ssh/doc.go:12: others.
Possibly doc.go should be renamed ssh.go. I'll leave that to AGL.

http://codereview.appspot.com/5905048/diff/10/ssh/example_test.go
File ssh/example_test.go (right):

http://codereview.appspot.com/5905048/diff/10/ssh/example_test.go#newcode17
ssh/example_test.go:17: config := new(ServerConfig)
config := &ServerConfig {
    PasswordCallback = func(conn *ServerConn, user, pass string) bool {
       return user == "testuser" && pass == "tiger"
    }
}

http://codereview.appspot.com/5905048/diff/10/ssh/example_test.go#newcode21
ssh/example_test.go:21: config.PublicKeyCallback = nil
drop

http://codereview.appspot.com/5905048/diff/10/ssh/example_test.go#newcode45
ssh/example_test.go:45: // An SSH connection multiplexes several channels, which
must
A ServerConn multiplexes ...

http://codereview.appspot.com/5905048/diff/10/ssh/example_test.go#newcode46
ssh/example_test.go:46: // be accepted themselves:
themselves be Accepted.

http://codereview.appspot.com/5905048/diff/10/ssh/example_test.go#newcode80
ssh/example_test.go:80: println(line)
fmt.Println(line) 

// fmt was imported for ExampleDial

http://codereview.appspot.com/5905048/diff/10/ssh/example_test.go#newcode82
ssh/example_test.go:82: return
drop

http://codereview.appspot.com/5905048/diff/10/ssh/example_test.go#newcode115
ssh/example_test.go:115: b := new(bytes.Buffer)
var b bytes.Buffer

[fhs, 2012-03-27 18:24:11]

Hello golang-dev@googlegroups.com, dave@cheney.net (cc:
golang-dev@googlegroups.com),

Please take another look.

[agl1, 2012-03-27 18:40:55]

*** Submitted as
http://code.google.com/p/go/source/detail?r=fbae31f0f8f0&repo=crypto ***

go.crypto/ssh: fix example in documentation

R=golang-dev, dave
CC=golang-dev
http://codereview.appspot.com/5905048

Committer: Adam Langley <agl@golang.org>

http://codereview.appspot.com/5905048/diff/9001/ssh/example_test.go
File ssh/example_test.go (right):

http://codereview.appspot.com/5905048/diff/9001/ssh/example_test.go#newcode64
ssh/example_test.go:64: return
s/return/continue/. Will tweak when landing.

[fhs, 2013-04-08 00:16:07]

*** Abandoned ***