1
0
mirror of https://github.com/golang/go synced 2024-11-18 12:04:57 -07:00
go/cmd/godoc
Dave Cheney 0ee0dd6ea8 cmd/godoc: skip tests on arm platforms
Skip tests on arm platforms.

The godoc tests require large amounts of memory, in excess of 700mb in -index mode which none of the arm builders have spare.

Because of their requirements the tests can be killed by the test runner leaving stray godoc processes spinning in swap trying to -index.

Change-Id: I1544d56e9d9aabbbaac21adeebfb9e2690bd2da5
Reviewed-on: https://go-review.googlesource.com/7540
Reviewed-by: Andrew Gerrand <adg@golang.org>
2015-03-16 02:06:44 +00:00
..
appinit.go cmd/godoc: exclude /pkg from search indexing 2015-03-12 00:26:38 +00:00
blog.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11:00
codewalk.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11:00
dl.go go.tools/cmd/godoc: register redirect handler for /dl/ 2014-06-18 15:44:09 +10:00
doc.go cmd/godoc: mention examples feature in godoc 2015-01-08 02:02:02 +00:00
godoc_test.go cmd/godoc: skip tests on arm platforms 2015-03-16 02:06:44 +00:00
handlers.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11:00
index.go cmd/godoc: exclude /pkg from search indexing 2015-03-12 00:26:38 +00:00
main.go cmd/godoc: exclude /pkg from search indexing 2015-03-12 00:26:38 +00:00
play.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11:00
README.godoc-app go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11: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 cmd/godoc: update GAE setup script 2014-12-19 02:48:01 +00:00
x.go cmd/godoc: add golang.org/x/tour meta redirect 2015-02-10 05:48:21 +00:00

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 golang.org/x/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
	golang.org/x/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 .