close_issue_2
/
tools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
tools/cmd/godoc
History
Andrew Gerrand 5b307dbe98 [release-branch.go1.3] go.tools/godoc: fix index reading and writing 
««« CL 103370046 / 3b66a5dfbfe1
go.tools/godoc: fix index reading and writing

In command godoc, set IndexEnabled when the -write_index flag is set.
Previously you would need to (unintuitively) set the -http flag to
achieve this.

In package godoc, set up the FS tree before loading the index, and
then return before starting the index refresh loop. Previously the
index would be loaded and then immediately refreshed, negating the
benefits of the on-disk index.

TBR=bradfitz
R=golang-codereviews
CC=golang-codereviews
https://golang.org/cl/103370046
»»»

TBR=bradfitz
R=bradfitz
CC=golang-codereviews
https://golang.org/cl/105190043
 		2014-06-13 16:54:49 +10:00
..
README.godoc-app go.tools/cmd/godoc: fix app engine version; update build script and readme 2013-10-03 14:29:16 +10:00
appinit.go go.tools/cmd/godoc: fix app engine version; update build script and readme 2013-10-03 14:29:16 +10:00
blog.go go.tools/cmd/blog: handle "/blog/" redirect properly 2013-10-03 18:10:57 +10:00
codewalk.go go.tools/godoc: move redirect helpers to new package 2013-10-01 16:32:13 +10:00
doc.go godoc: documentation of -analysis features. 2014-04-16 16:35:08 -04:00
godoc_test.go go.tools: fix various minor issues found by go vet 2014-05-19 08:47:28 -07:00
handlers.go go.tools/godoc: server mode: add support for type and pointer analysis. 2014-03-14 18:58:22 -04:00
main.go [release-branch.go1.3] go.tools/godoc: fix index reading and writing 2014-06-13 16:54:49 +10:00
play.go go.tools/cmd/godoc: update import paths 2013-09-19 10:59:21 +10:00
remotesearch.go go.tools/cmd/godoc: update appinit.go to use new godoc packages 2013-07-30 14:23:23 +10:00
setup-godoc-app.bash go.tools/cmd/godoc: fix app engine version; update build script and readme 2013-10-03 14:29:16 +10:00

README.godoc-app 

godoc on appengine
------------------

Prerequisites
-------------

* Go appengine SDK
  https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_for_Go

* Go sources at tip under $GOROOT

* Godoc sources at tip inside $GOPATH
  (go get -d code.google.com/p/go.tools/cmd/godoc)


Directory structure
-------------------

* Let $APPDIR be the directory containing the app engine files.
  (e.g., $APPDIR=$HOME/godoc-app)

* $APPDIR contains the following entries (this may change depending on
  app-engine release and version of godoc):

	app.yaml
	code.google.com/p/go.tools/cmd/godoc
	godoc.zip
	index.split.*

* The app.yaml file is set up per app engine documentation.
  For instance:

	application: godoc-app
	version: 1
	runtime: go
	api_version: go1

	handlers:
	- url: /.*
	  script: _go_app


Configuring and running godoc
-----------------------------

To configure godoc, run

	bash setup-godoc-app.bash

to prepare an $APPDIR as described above. See the script for details on usage.

To run godoc locally, using the App Engine development server, run

	<path to go_appengine>/dev_appserver.py $APPDIR

godoc should come up at http://localhost:8080 .