2009-10-30 11:58:53 -06:00
|
|
|
// Copyright 2009 The Go Authors. All rights reserved.
|
|
|
|
// Use of this source code is governed by a BSD-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
|
|
|
// godoc: Go Documentation Server
|
|
|
|
|
|
|
|
// Web server tree:
|
|
|
|
//
|
|
|
|
// http://godoc/ main landing page
|
|
|
|
// http://godoc/doc/ serve from $GOROOT/doc - spec, mem, tutorial, etc.
|
|
|
|
// http://godoc/src/ serve files from $GOROOT/src; .go gets pretty-printed
|
2010-03-29 19:06:53 -06:00
|
|
|
// http://godoc/cmd/ serve documentation about commands
|
2009-10-30 11:58:53 -06:00
|
|
|
// http://godoc/pkg/ serve documentation about packages
|
|
|
|
// (idea is if you say import "compress/zlib", you go to
|
|
|
|
// http://godoc/pkg/compress/zlib)
|
|
|
|
//
|
|
|
|
// Command-line interface:
|
|
|
|
//
|
|
|
|
// godoc packagepath [name ...]
|
|
|
|
//
|
|
|
|
// godoc compress/zlib
|
|
|
|
// - prints doc for package compress/zlib
|
|
|
|
// godoc crypto/block Cipher NewCMAC
|
|
|
|
// - prints doc for Cipher and NewCMAC in package crypto/block
|
|
|
|
|
|
|
|
package main
|
|
|
|
|
|
|
|
import (
|
2009-12-15 16:33:31 -07:00
|
|
|
"bytes"
|
2010-03-29 19:06:53 -06:00
|
|
|
_ "expvar" // to serve /debug/vars
|
2009-12-15 16:33:31 -07:00
|
|
|
"flag"
|
|
|
|
"fmt"
|
2010-03-29 19:06:53 -06:00
|
|
|
"go/ast"
|
2009-12-15 16:33:31 -07:00
|
|
|
"http"
|
2010-03-29 14:06:26 -06:00
|
|
|
_ "http/pprof" // to serve /debug/pprof/*
|
2009-12-15 16:33:31 -07:00
|
|
|
"io"
|
|
|
|
"log"
|
|
|
|
"os"
|
2010-02-19 17:23:19 -07:00
|
|
|
pathutil "path"
|
2010-03-29 19:06:53 -06:00
|
|
|
"regexp"
|
2010-03-19 16:20:20 -06:00
|
|
|
"runtime"
|
2010-03-29 19:06:53 -06:00
|
|
|
"strings"
|
2009-12-15 16:33:31 -07:00
|
|
|
"time"
|
2009-10-30 11:58:53 -06:00
|
|
|
)
|
|
|
|
|
2010-03-24 15:51:55 -06:00
|
|
|
const defaultAddr = ":6060" // default webserver address
|
2010-03-19 13:46:43 -06:00
|
|
|
|
2009-10-30 11:58:53 -06:00
|
|
|
var (
|
|
|
|
// periodic sync
|
2010-03-16 17:45:54 -06:00
|
|
|
syncCmd = flag.String("sync", "", "sync command; disabled if empty")
|
|
|
|
syncMin = flag.Int("sync_minutes", 0, "sync interval in minutes; disabled if <= 0")
|
2010-09-14 12:16:36 -06:00
|
|
|
syncDelay delayTime // actual sync interval in minutes; usually syncDelay == syncMin, but syncDelay may back off exponentially
|
2009-10-30 11:58:53 -06:00
|
|
|
|
2010-03-19 13:46:43 -06:00
|
|
|
// network
|
|
|
|
httpAddr = flag.String("http", "", "HTTP service address (e.g., '"+defaultAddr+"')")
|
|
|
|
serverAddr = flag.String("server", "", "webserver address for command line searches")
|
2009-10-30 11:58:53 -06:00
|
|
|
|
|
|
|
// layout control
|
2010-03-29 19:06:53 -06:00
|
|
|
html = flag.Bool("html", false, "print HTML in command-line mode")
|
|
|
|
srcMode = flag.Bool("src", false, "print (exported) source in command-line mode")
|
2010-03-19 13:46:43 -06:00
|
|
|
|
|
|
|
// command-line searches
|
|
|
|
query = flag.Bool("q", false, "arguments are considered search queries")
|
2009-10-30 11:58:53 -06:00
|
|
|
)
|
|
|
|
|
|
|
|
|
2010-09-28 22:30:12 -06:00
|
|
|
func serveError(w http.ResponseWriter, r *http.Request, relpath string, err os.Error) {
|
2010-02-18 18:40:50 -07:00
|
|
|
contents := applyTemplate(errorHTML, "errorHTML", err) // err may contain an absolute path!
|
2010-09-28 22:30:12 -06:00
|
|
|
w.WriteHeader(http.StatusNotFound)
|
|
|
|
servePage(w, "File "+relpath, "", "", contents)
|
2010-02-18 18:40:50 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2010-09-28 22:30:12 -06:00
|
|
|
func exec(rw http.ResponseWriter, args []string) (status int) {
|
2009-12-15 16:33:31 -07:00
|
|
|
r, w, err := os.Pipe()
|
2009-10-30 11:58:53 -06:00
|
|
|
if err != nil {
|
2011-01-10 16:34:29 -07:00
|
|
|
log.Printf("os.Pipe(): %v", err)
|
2009-12-15 16:33:31 -07:00
|
|
|
return 2
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
2009-12-15 16:33:31 -07:00
|
|
|
bin := args[0]
|
|
|
|
fds := []*os.File{nil, w, w}
|
2009-10-30 11:58:53 -06:00
|
|
|
if *verbose {
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
log.Printf("executing %v", args)
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
2010-03-19 16:20:20 -06:00
|
|
|
pid, err := os.ForkExec(bin, args, os.Environ(), *goroot, fds)
|
2009-12-15 16:33:31 -07:00
|
|
|
defer r.Close()
|
|
|
|
w.Close()
|
2009-10-30 11:58:53 -06:00
|
|
|
if err != nil {
|
2011-01-10 16:34:29 -07:00
|
|
|
log.Printf("os.ForkExec(%q): %v", bin, err)
|
2009-12-15 16:33:31 -07:00
|
|
|
return 2
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
2009-12-15 16:33:31 -07:00
|
|
|
var buf bytes.Buffer
|
|
|
|
io.Copy(&buf, r)
|
|
|
|
wait, err := os.Wait(pid, 0)
|
2009-10-30 11:58:53 -06:00
|
|
|
if err != nil {
|
2009-12-15 16:33:31 -07:00
|
|
|
os.Stderr.Write(buf.Bytes())
|
2011-01-10 16:34:29 -07:00
|
|
|
log.Printf("os.Wait(%d, 0): %v", pid, err)
|
2009-12-15 16:33:31 -07:00
|
|
|
return 2
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
2009-12-15 16:33:31 -07:00
|
|
|
status = wait.ExitStatus()
|
2009-11-05 23:25:46 -07:00
|
|
|
if !wait.Exited() || status > 1 {
|
2009-12-15 16:33:31 -07:00
|
|
|
os.Stderr.Write(buf.Bytes())
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
log.Printf("executing %v failed (exit status = %d)", args, status)
|
2009-12-15 16:33:31 -07:00
|
|
|
return
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
if *verbose {
|
2009-11-09 13:07:39 -07:00
|
|
|
os.Stderr.Write(buf.Bytes())
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
2010-09-28 22:30:12 -06:00
|
|
|
if rw != nil {
|
|
|
|
rw.SetHeader("content-type", "text/plain; charset=utf-8")
|
|
|
|
rw.Write(buf.Bytes())
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
2009-12-15 16:33:31 -07:00
|
|
|
return
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2010-09-28 22:30:12 -06:00
|
|
|
func dosync(w http.ResponseWriter, r *http.Request) {
|
2009-12-15 16:33:31 -07:00
|
|
|
args := []string{"/bin/sh", "-c", *syncCmd}
|
2010-09-28 22:30:12 -06:00
|
|
|
switch exec(w, args) {
|
2009-11-01 11:33:16 -07:00
|
|
|
case 0:
|
2009-11-02 10:25:39 -07:00
|
|
|
// sync succeeded and some files have changed;
|
2009-11-02 23:44:01 -07:00
|
|
|
// update package tree.
|
|
|
|
// TODO(gri): The directory tree may be temporarily out-of-sync.
|
|
|
|
// Consider keeping separate time stamps so the web-
|
|
|
|
// page can indicate this discrepancy.
|
2011-01-10 16:34:29 -07:00
|
|
|
initFSTree()
|
2009-12-15 16:33:31 -07:00
|
|
|
fallthrough
|
2009-11-01 11:33:16 -07:00
|
|
|
case 1:
|
2009-11-02 10:25:39 -07:00
|
|
|
// sync failed because no files changed;
|
|
|
|
// don't change the package tree
|
2009-12-15 16:33:31 -07:00
|
|
|
syncDelay.set(*syncMin) // revert to regular sync schedule
|
2009-11-01 11:33:16 -07:00
|
|
|
default:
|
|
|
|
// sync failed because of an error - back off exponentially, but try at least once a day
|
2009-11-09 22:09:34 -07:00
|
|
|
syncDelay.backoff(24 * 60)
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
func usage() {
|
|
|
|
fmt.Fprintf(os.Stderr,
|
2009-12-09 17:54:07 -07:00
|
|
|
"usage: godoc package [name ...]\n"+
|
2010-03-19 13:46:43 -06:00
|
|
|
" godoc -http="+defaultAddr+"\n")
|
2009-12-15 16:33:31 -07:00
|
|
|
flag.PrintDefaults()
|
|
|
|
os.Exit(2)
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
func loggingHandler(h http.Handler) http.Handler {
|
2010-09-28 22:30:12 -06:00
|
|
|
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
log.Printf("%s\t%s", w.RemoteAddr(), req.URL)
|
2010-09-28 22:30:12 -06:00
|
|
|
h.ServeHTTP(w, req)
|
2009-11-09 13:07:39 -07:00
|
|
|
})
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2010-03-24 15:51:55 -06:00
|
|
|
func remoteSearch(query string) (res *http.Response, err os.Error) {
|
|
|
|
search := "/search?f=text&q=" + http.URLEscape(query)
|
|
|
|
|
|
|
|
// list of addresses to try
|
|
|
|
var addrs []string
|
2010-03-19 13:46:43 -06:00
|
|
|
if *serverAddr != "" {
|
2010-03-24 15:51:55 -06:00
|
|
|
// explicit server address - only try this one
|
|
|
|
addrs = []string{*serverAddr}
|
2010-03-19 13:46:43 -06:00
|
|
|
} else {
|
2010-03-24 15:51:55 -06:00
|
|
|
addrs = []string{
|
|
|
|
defaultAddr,
|
|
|
|
"golang.org",
|
2010-03-19 13:46:43 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2010-03-24 15:51:55 -06:00
|
|
|
// remote search
|
|
|
|
for _, addr := range addrs {
|
|
|
|
url := "http://" + addr + search
|
|
|
|
res, _, err = http.Get(url)
|
|
|
|
if err == nil && res.StatusCode == http.StatusOK {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if err == nil && res.StatusCode != http.StatusOK {
|
|
|
|
err = os.NewError(res.Status)
|
2010-03-19 13:46:43 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2010-03-29 19:06:53 -06:00
|
|
|
// Does s look like a regular expression?
|
|
|
|
func isRegexp(s string) bool {
|
|
|
|
return strings.IndexAny(s, ".(|)*+?^$[]") >= 0
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// Make a regular expression of the form
|
|
|
|
// names[0]|names[1]|...names[len(names)-1].
|
|
|
|
// Returns nil if the regular expression is illegal.
|
|
|
|
func makeRx(names []string) (rx *regexp.Regexp) {
|
|
|
|
if len(names) > 0 {
|
|
|
|
s := ""
|
|
|
|
for i, name := range names {
|
|
|
|
if i > 0 {
|
|
|
|
s += "|"
|
|
|
|
}
|
|
|
|
if isRegexp(name) {
|
|
|
|
s += name
|
|
|
|
} else {
|
|
|
|
s += "^" + name + "$" // must match exactly
|
|
|
|
}
|
|
|
|
}
|
|
|
|
rx, _ = regexp.Compile(s) // rx is nil if there's a compilation error
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2009-10-30 11:58:53 -06:00
|
|
|
func main() {
|
2009-12-15 16:33:31 -07:00
|
|
|
flag.Usage = usage
|
|
|
|
flag.Parse()
|
2009-10-30 11:58:53 -06:00
|
|
|
|
2009-11-09 00:42:00 -07:00
|
|
|
// Check usage: either server and no args, or command line and args
|
2010-03-19 13:46:43 -06:00
|
|
|
if (*httpAddr != "") != (flag.NArg() == 0) {
|
2009-11-09 13:07:39 -07:00
|
|
|
usage()
|
2009-11-09 00:42:00 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
if *tabwidth < 0 {
|
2009-11-09 13:07:39 -07:00
|
|
|
log.Exitf("negative tabwidth %d", *tabwidth)
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
2010-02-16 13:49:41 -07:00
|
|
|
initHandlers()
|
2009-12-15 16:33:31 -07:00
|
|
|
readTemplates()
|
2009-10-30 11:58:53 -06:00
|
|
|
|
2010-03-19 13:46:43 -06:00
|
|
|
if *httpAddr != "" {
|
2009-11-08 22:46:20 -07:00
|
|
|
// HTTP server mode.
|
2009-12-15 16:33:31 -07:00
|
|
|
var handler http.Handler = http.DefaultServeMux
|
2009-10-30 11:58:53 -06:00
|
|
|
if *verbose {
|
2011-01-10 16:34:29 -07:00
|
|
|
log.Printf("Go Documentation Server")
|
|
|
|
log.Printf("version = %s", runtime.Version())
|
|
|
|
log.Printf("address = %s", *httpAddr)
|
|
|
|
log.Printf("goroot = %s", *goroot)
|
|
|
|
log.Printf("tabwidth = %d", *tabwidth)
|
2011-01-19 15:33:05 -07:00
|
|
|
if *maxResults > 0 {
|
|
|
|
log.Printf("maxresults = %d (full text index enabled)", *maxResults)
|
2011-01-10 16:34:29 -07:00
|
|
|
}
|
2010-02-16 12:20:55 -07:00
|
|
|
if !fsMap.IsEmpty() {
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
log.Print("user-defined mapping:")
|
2010-02-16 12:20:55 -07:00
|
|
|
fsMap.Fprint(os.Stderr)
|
|
|
|
}
|
2009-12-15 16:33:31 -07:00
|
|
|
handler = loggingHandler(handler)
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
2009-12-15 16:33:31 -07:00
|
|
|
registerPublicHandlers(http.DefaultServeMux)
|
2009-10-30 11:58:53 -06:00
|
|
|
if *syncCmd != "" {
|
2009-11-09 13:07:39 -07:00
|
|
|
http.Handle("/debug/sync", http.HandlerFunc(dosync))
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
2010-09-14 12:16:36 -06:00
|
|
|
// Initialize default directory tree with corresponding timestamp.
|
2010-11-18 20:55:38 -07:00
|
|
|
// (Do it in a goroutine so that launch is quick.)
|
2011-01-10 16:34:29 -07:00
|
|
|
go initFSTree()
|
2010-09-14 12:16:36 -06:00
|
|
|
|
|
|
|
// Initialize directory trees for user-defined file systems (-path flag).
|
|
|
|
initDirTrees()
|
2009-10-30 11:58:53 -06:00
|
|
|
|
|
|
|
// Start sync goroutine, if enabled.
|
|
|
|
if *syncCmd != "" && *syncMin > 0 {
|
2009-12-15 16:33:31 -07:00
|
|
|
syncDelay.set(*syncMin) // initial sync delay
|
2009-10-30 11:58:53 -06:00
|
|
|
go func() {
|
|
|
|
for {
|
2009-12-15 16:33:31 -07:00
|
|
|
dosync(nil, nil)
|
|
|
|
delay, _ := syncDelay.get()
|
2009-10-30 11:58:53 -06:00
|
|
|
if *verbose {
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
log.Printf("next sync in %dmin", delay.(int))
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
2009-12-15 16:33:31 -07:00
|
|
|
time.Sleep(int64(delay.(int)) * 60e9)
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
2009-12-15 16:33:31 -07:00
|
|
|
}()
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
// Start indexing goroutine.
|
2009-12-15 16:33:31 -07:00
|
|
|
go indexer()
|
2009-10-30 11:58:53 -06:00
|
|
|
|
|
|
|
// Start http server.
|
2010-03-19 13:46:43 -06:00
|
|
|
if err := http.ListenAndServe(*httpAddr, handler); err != nil {
|
|
|
|
log.Exitf("ListenAndServe %s: %v", *httpAddr, err)
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
2010-03-19 13:46:43 -06:00
|
|
|
|
2009-12-15 16:33:31 -07:00
|
|
|
return
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
2009-11-02 10:25:39 -07:00
|
|
|
// Command line mode.
|
2009-10-30 11:58:53 -06:00
|
|
|
if *html {
|
2009-12-01 10:15:05 -07:00
|
|
|
packageText = packageHTML
|
2010-03-19 13:46:43 -06:00
|
|
|
searchText = packageHTML
|
|
|
|
}
|
|
|
|
|
|
|
|
if *query {
|
|
|
|
// Command-line queries.
|
|
|
|
for i := 0; i < flag.NArg(); i++ {
|
2010-03-24 15:51:55 -06:00
|
|
|
res, err := remoteSearch(flag.Arg(i))
|
2010-03-19 13:46:43 -06:00
|
|
|
if err != nil {
|
2010-03-24 15:51:55 -06:00
|
|
|
log.Exitf("remoteSearch: %s", err)
|
2010-03-19 13:46:43 -06:00
|
|
|
}
|
2010-03-24 15:51:55 -06:00
|
|
|
io.Copy(os.Stdout, res.Body)
|
2010-03-19 13:46:43 -06:00
|
|
|
}
|
|
|
|
return
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
2010-02-19 17:23:19 -07:00
|
|
|
// determine paths
|
|
|
|
path := flag.Arg(0)
|
|
|
|
if len(path) > 0 && path[0] == '.' {
|
|
|
|
// assume cwd; don't assume -goroot
|
|
|
|
cwd, _ := os.Getwd() // ignore errors
|
|
|
|
path = pathutil.Join(cwd, path)
|
|
|
|
}
|
|
|
|
relpath := path
|
|
|
|
abspath := path
|
|
|
|
if len(path) > 0 && path[0] != '/' {
|
|
|
|
abspath = absolutePath(path, pkgHandler.fsRoot)
|
|
|
|
} else {
|
|
|
|
relpath = relativePath(path)
|
|
|
|
}
|
|
|
|
|
2010-03-29 19:06:53 -06:00
|
|
|
var mode PageInfoMode
|
|
|
|
if *srcMode {
|
|
|
|
// only filter exports if we don't have explicit command-line filter arguments
|
|
|
|
if flag.NArg() == 1 {
|
|
|
|
mode |= exportsOnly
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
mode = exportsOnly | genDoc
|
|
|
|
}
|
2010-03-12 19:16:21 -07:00
|
|
|
// TODO(gri): Provide a mechanism (flag?) to select a package
|
|
|
|
// if there are multiple packages in a directory.
|
2010-08-10 10:52:02 -06:00
|
|
|
info := pkgHandler.getPageInfo(abspath, relpath, "", mode)
|
2009-11-03 20:40:26 -07:00
|
|
|
|
2010-08-10 10:52:02 -06:00
|
|
|
if info.Err != nil || info.PAst == nil && info.PDoc == nil && info.Dirs == nil {
|
2009-11-03 20:40:26 -07:00
|
|
|
// try again, this time assume it's a command
|
2010-02-19 17:23:19 -07:00
|
|
|
if len(path) > 0 && path[0] != '/' {
|
|
|
|
abspath = absolutePath(path, cmdHandler.fsRoot)
|
|
|
|
}
|
2010-03-29 19:06:53 -06:00
|
|
|
info = cmdHandler.getPageInfo(abspath, relpath, "", mode)
|
2009-11-03 20:40:26 -07:00
|
|
|
}
|
2010-08-10 10:52:02 -06:00
|
|
|
if info.Err != nil {
|
|
|
|
log.Exitf("%v", info.Err)
|
|
|
|
}
|
2009-10-30 11:58:53 -06:00
|
|
|
|
2010-03-29 19:06:53 -06:00
|
|
|
// If we have more than one argument, use the remaining arguments for filtering
|
|
|
|
if flag.NArg() > 1 {
|
|
|
|
args := flag.Args()[1:]
|
|
|
|
rx := makeRx(args)
|
|
|
|
if rx == nil {
|
|
|
|
log.Exitf("illegal regular expression from %v", args)
|
|
|
|
}
|
|
|
|
|
|
|
|
filter := func(s string) bool { return rx.MatchString(s) }
|
|
|
|
switch {
|
|
|
|
case info.PAst != nil:
|
|
|
|
ast.FilterFile(info.PAst, filter)
|
2010-03-30 12:19:58 -06:00
|
|
|
// Special case: Don't use templates for printing
|
|
|
|
// so we only get the filtered declarations without
|
|
|
|
// package clause or extra whitespace.
|
|
|
|
for i, d := range info.PAst.Decls {
|
|
|
|
if i > 0 {
|
|
|
|
fmt.Println()
|
|
|
|
}
|
go/ast: use token.Pos instead of token.Position; adjust all dependent code
Specifically:
* lib/godoc:
- provide file set (FSet) argument to formatters where needed
* src/cmd:
- cgo, ebnflint, godoc, gofmt, goinstall: provide file set (fset) where needed
- godoc: remove local binary search with sort.Search (change by rsc),
extract file set for formatters
* src/pkg:
- exp/eval: remove embedded token.Position fields from nodes and replace
with named token.Pos fields; add corresponding Pos() accessor methods
- go/token: added file.Line(), changed signature of File.Position()
* test/fixedbugs/:
- bug206.go: change test to not rely on token.Pos details
* added various extra comments
* Runs all.bash
* gofmt formats all of src, misc w/o changes
* godoc runs
* performance:
- The new version of godoc consumes about the same space after indexing
has completed, but indexing is half the speed. Significant space savings
are expected from smaller ASTs, but since they are thrown away after a
file has been indexed, this is not visible anymore. The slower indexing
time is due to the much more expensive computation of line information.
However, with the new compressed position information, indexing can be
rewritten and simplified. Furthermore, computing the line info can be
done more efficiently.
New godoc, immediately after indexing completed (best of three runs):
PID COMMAND %CPU TIME #TH #PRTS #MREGS RPRVT RSHRD RSIZE VSIZE
44381 godoc 0.0% 0:38.00 4 19 149 145M 184K 148M 176M
2010/12/03 17:58:35 index updated (39.231s, 18505 unique words, 386387 spots)
2010/12/03 17:58:35 bytes=90858456 footprint=199182584
2010/12/03 17:58:36 bytes=47858568 footprint=167295224
Old godoc, immediately after indexing completed (best of three runs):
PID COMMAND %CPU TIME #TH #PRTS #MREGS RPRVT RSHRD RSIZE VSIZE
23167 godoc 0.0% 0:22.02 4 17 132 129M 184K 132M 173M
2010/12/03 14:51:32 index updated (24.892s, 18765 unique words, 393830 spots)
2010/12/03 14:51:32 bytes=66404528 footprint=163907832
2010/12/03 14:51:32 bytes=46282224 footprint=163907832
The different numbers for unique words/spots stem from the fact the the
two workspaces are not exactly identical. The new godoc maintains a large
file set data structure during indexing which (probably) is the reason
for the larger heap (90858456 vs 66404528) before garbage collection.
R=rsc, r
CC=golang-dev
https://golang.org/cl/3050041
2010-12-06 15:23:18 -07:00
|
|
|
writeAny(os.Stdout, info.FSet, *html, d)
|
2010-03-30 12:19:58 -06:00
|
|
|
fmt.Println()
|
|
|
|
}
|
|
|
|
return
|
|
|
|
|
2010-03-29 19:06:53 -06:00
|
|
|
case info.PDoc != nil:
|
|
|
|
info.PDoc.Filter(filter)
|
|
|
|
}
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
if err := packageText.Execute(info, os.Stdout); err != nil {
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
log.Printf("packageText.Execute: %s", err)
|
2009-10-30 11:58:53 -06:00
|
|
|
}
|
|
|
|
}
|