code review 1960050: go/doc: use correct escaper for URL

go/doc: use correct escaper for URL

Despite the name, URL escaping is for a small subpiece of the URL only.
This particular URL is being emitted in an <a href=""> tag and in that
context it should be HTML escaped, not URL escaped.

In addition to fixing a bug, this change cuts a dependency chain
from go/doc to net, clearing the way for use of cgo
(which imports go/doc) during the compilation of package net.

[rsc, 2010-08-25 05:26:55]

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

I'd like you to review this change.

[gri, 2010-08-25 06:52:18]

LGTM
- gri

On Tue, Aug 24, 2010 at 10:26 PM, <rsc@golang.org> wrote:

> Reviewers: gri,
>
> Message:
> Hello gri (cc: golang-dev@googlegroups.com),
>
> I'd like you to review this change.
>
>
> Description:
> go/doc: use correct escaper for URL
>
> Despite the name, URL escaping is for a small subpiece of the URL only.
> This particular URL is being emitted in an <a href=""> tag and in that
> context it should be HTML escaped, not URL escaped.
>
> In addition to fixing a bug, this change cuts a dependency chain
> from go/doc to net, clearing the way for use of cgo
> (which imports go/doc) during the compilation of package net.
>
> Please review this at http://codereview.appspot.com/1960050/
>
> Affected files:
>  M src/pkg/go/doc/comment.go
>
>
> Index: src/pkg/go/doc/comment.go
> ===================================================================
> --- a/src/pkg/go/doc/comment.go
> +++ b/src/pkg/go/doc/comment.go
> @@ -8,7 +8,6 @@
>
>  import (
>        "go/ast"
> -       "http" // for URLEscape
>        "io"
>        "regexp"
>        "strings"
> @@ -227,7 +226,7 @@
>                // write match
>                if len(url) > 0 {
>                        w.Write(html_a)
> -                       w.Write([]byte(http.URLEscape(url)))
> +                       template.HTMLEscape(w, []byte(url))
>                        w.Write(html_aq)
>                }
>                if italics {
>
>
>

[rsc, 2010-08-25 15:00:45]

*** Submitted as http://code.google.com/p/go/source/detail?r=b3d25117271a ***

go/doc: use correct escaper for URL

Despite the name, URL escaping is for a small subpiece of the URL only.
This particular URL is being emitted in an <a href=""> tag and in that
context it should be HTML escaped, not URL escaped.

In addition to fixing a bug, this change cuts a dependency chain
from go/doc to net, clearing the way for use of cgo
(which imports go/doc) during the compilation of package net.

R=gri
CC=golang-dev
http://codereview.appspot.com/1960050