code review 7085054: cmd/godoc: support m=text parameter for text files

cmd/godoc: support m=text parameter for text files

It's possible to view the package docs in plain text, eg:
        http://golang.org/pkg/time/?m=text
and this CL introduces the ability to do the same for files:
        http://golang.org/src/pkg/time/time.go?m=text

[adg, 2013-01-13 21:37:39]

Hello golang-dev@googlegroups.com,

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

[dave_cheney.net, 2013-01-13 21:42:15]

m is a bit obscure, is there a reason for it? Would format=text (and
thus format=html being the default) make more sense ?

On Mon, Jan 14, 2013 at 8:37 AM,  <adg@golang.org> wrote:
> Reviewers: golang-dev_googlegroups.com,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://code.google.com/p/go
>
>
> Description:
> cmd/godoc: support m=text parameter for text files
>
> It's possible to view the package docs in plain text, eg:
>         http://golang.org/pkg/time/?m=text
> and this CL introduces the ability to do the same for files:
>         http://golang.org/src/pkg/time/time.go?m=text
>
> Please review this at https://codereview.appspot.com/7085054/
>
> Affected files:
>   M src/cmd/godoc/godoc.go
>
>
> Index: src/cmd/godoc/godoc.go
> ===================================================================
> --- a/src/cmd/godoc/godoc.go
> +++ b/src/cmd/godoc/godoc.go
> @@ -15,6 +15,7 @@
>         "go/format"
>         "go/printer"
>         "go/token"
> +       htmlpkg "html"
>         "io"
>         "io/ioutil"
>         "log"
> @@ -681,10 +682,16 @@
>                 return
>         }
>
> +       if r.FormValue("m") == "text" {
> +               serveText(w, src)
> +               return
> +       }
> +
>         var buf bytes.Buffer
>         buf.WriteString("<pre>")
>         FormatText(&buf, src, 1, pathpkg.Ext(abspath) == ".go",
> r.FormValue("h"), rangeSelection(r.FormValue("s")))
>         buf.WriteString("</pre>")
> +       fmt.Fprintf(&buf, `<p><a href="/%s?m=text">View as plain
> text</a></p>`, htmlpkg.EscapeString(relpath))
>
>         servePage(w, Page{
>                 Title:    title + " " + relpath,
>
>

[minux1, 2013-01-13 21:47:43]

LGTM.
I missed this feature for quite some time but forgot to
investigate. Thank you.

[minux1, 2013-01-13 21:49:02]

On 2013/01/13 21:42:15, dfc wrote:
> m is a bit obscure, is there a reason for it? Would format=text (and
> thus format=html being the default) make more sense ?
m is documented flag for cmd/godoc, and it also has
other flags (like all,methods,src,flat) that don't control
formatting.

[dave_cheney.net, 2013-01-13 21:50:24]

Well there you go, ignore my uninformed suggestion.

On Mon, Jan 14, 2013 at 8:49 AM,  <minux.ma@gmail.com> wrote:
> On 2013/01/13 21:42:15, dfc wrote:
>>
>> m is a bit obscure, is there a reason for it? Would format=text (and
>> thus format=html being the default) make more sense ?
>
> m is documented flag for cmd/godoc, and it also has
> other flags (like all,methods,src,flat) that don't control
> formatting.
>
> https://codereview.appspot.com/7085054/

[adg, 2013-01-13 22:35:15]

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

cmd/godoc: support m=text parameter for text files

It's possible to view the package docs in plain text, eg:
        http://golang.org/pkg/time/?m=text
and this CL introduces the ability to do the same for files:
        http://golang.org/src/pkg/time/time.go?m=text

R=golang-dev, dave, minux.ma
CC=golang-dev
https://codereview.appspot.com/7085054