Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
G
golang
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
go
golang
Commits
3a065c5a
Commit
3a065c5a
authored
Mar 07, 2012
by
Robert Griesemer
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
godoc: update documentation
R=rsc CC=golang-dev
https://golang.org/cl/5758057
parent
a324a5ac
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
16 deletions
+8
-16
doc.go
src/cmd/godoc/doc.go
+8
-16
No files found.
src/cmd/godoc/doc.go
View file @
3a065c5a
...
@@ -25,7 +25,7 @@ In command-line mode, the -q flag enables search queries against a godoc running
...
@@ -25,7 +25,7 @@ In command-line mode, the -q flag enables search queries against a godoc running
as a webserver. If no explicit server address is specified with the -server flag,
as a webserver. If no explicit server address is specified with the -server flag,
godoc first tries localhost:6060 and then http://golang.org.
godoc first tries localhost:6060 and then http://golang.org.
godoc -q Reader
Writer
godoc -q Reader
godoc -q math.Sin
godoc -q math.Sin
godoc -server=:6060 -q sin
godoc -server=:6060 -q sin
...
@@ -87,17 +87,15 @@ The flags are:
...
@@ -87,17 +87,15 @@ The flags are:
directory containing alternate template files; if set,
directory containing alternate template files; if set,
the directory may provide alternative template files
the directory may provide alternative template files
for the files in $GOROOT/lib/godoc
for the files in $GOROOT/lib/godoc
-filter=""
filter file containing permitted package directory paths
-filter_minutes=0
filter file update interval in minutes; update is disabled if <= 0
-zip=""
-zip=""
zip file providing the file system to serve; disabled if empty
zip file providing the file system to serve; disabled if empty
The -path flag accepts a list of colon-separated paths; unrooted paths are relative
By default, godoc looks at the packages it finds via $GOROOT and $GOPATH (if set).
to the current working directory. Each path is considered as an additional root for
Additional directories may be specified via the -path flag which accepts a list
packages in order of appearance. The last (absolute) path element is the prefix for
of colon-separated paths; unrooted paths are relative to the current working
the package path. For instance, given the flag value:
directory. Each path is considered as an additional root for packages in order
of appearance. The last (absolute) path element is the prefix for the package
path. For instance, given the flag value:
path=".:/home/bar:/public"
path=".:/home/bar:/public"
...
@@ -108,13 +106,6 @@ as follows:
...
@@ -108,13 +106,6 @@ as follows:
/home/bar/x -> bar/x
/home/bar/x -> bar/x
/public/x -> public/x
/public/x -> public/x
Paths provided via -path may point to very large file systems that contain
non-Go files. Creating the subtree of directories with Go packages may take
a long amount of time. A file containing newline-separated directory paths
may be provided with the -filter flag; if it exists, only directories
on those paths are considered. If -filter_minutes is set, the filter_file is
updated regularly by walking the entire directory tree.
When godoc runs as a web server and -index is set, a search index is maintained.
When godoc runs as a web server and -index is set, a search index is maintained.
The index is created at startup and is automatically updated every time the
The index is created at startup and is automatically updated every time the
-sync command terminates with exit status 0, indicating that files have changed.
-sync command terminates with exit status 0, indicating that files have changed.
...
@@ -159,5 +150,6 @@ one may run godoc as follows:
...
@@ -159,5 +150,6 @@ one may run godoc as follows:
See "Godoc: documenting Go code" for how to write good comments for godoc:
See "Godoc: documenting Go code" for how to write good comments for godoc:
http://blog.golang.org/2011/03/godoc-documenting-go-code.html
http://blog.golang.org/2011/03/godoc-documenting-go-code.html
*/
*/
package
documentation
package
documentation
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment