summaryrefslogtreecommitdiff
path: root/gopher.go
diff options
context:
space:
mode:
authortjpcc <tjp@ctrl-c.club>2023-09-23 13:01:11 -0600
committertjpcc <tjp@ctrl-c.club>2023-09-23 13:03:19 -0600
commitd59ed1060d354ce911da1e7fb19f651feeafa2c1 (patch)
treee751e6e113c665c86fd9411fe53caf91c4b0d582 /gopher.go
parent6cfa6622f31953bd75bfae4c9b10915e3dd6bd78 (diff)
use :repository as the repo name key
Diffstat (limited to 'gopher.go')
-rw-r--r--gopher.go36
1 files changed, 18 insertions, 18 deletions
diff --git a/gopher.go b/gopher.go
index e85599b..369bc29 100644
--- a/gopher.go
+++ b/gopher.go
@@ -17,33 +17,33 @@ import (
// GopherRouter builds a router that will handle gopher requests in a directory of git repositories.
//
// The routes it defines are:
-// / gophermap listing of the repositories in the directory
-// /:syw_reponame gophermap overview of the repository
-// /:syw_reponame/branches gophermap list of branches/head
-// /:syw_reponame/tags gophermap listing of tags
-// /:syw_reponame/refs/:ref gophermap overview of a ref
-// /:syw_reponame/refs/:ref/tree gophermap listing of a ref's root directory
-// /:syw_reponame/refs/:ref/tree/*path for directories: gophermap list of contents
-// for files: raw files (guessed item type text/binary/image/etc)
-// /:syw_reponame/diffstat/:fromref/:toref text diffstat between two refs
-// /:syw_reponame/diff/:fromref/:toref text diff between two refs
+// / gophermap listing of the repositories in the directory
+// /:repository gophermap overview of the repository
+// /:repository/branches gophermap list of branches/head
+// /:repository/tags gophermap listing of tags
+// /:repository/refs/:ref gophermap overview of a ref
+// /:repository/refs/:ref/tree gophermap listing of a ref's root directory
+// /:repository/refs/:ref/tree/*path for directories: gophermap list of contents
+// for files: raw files (guessed item type text/binary/image/etc)
+// /:repository/diffstat/:fromref/:toref text diffstat between two refs
+// /:repository/diff/:fromref/:toref text diff between two refs
//
// The overrides argument can provide templates to define the behavior of nearly all of the above routes.
// All of them have default implementations, so the argument can be nil, but otherwise the template names
// used are:
// repo_root.gophermap gophermap at /
-// repo_home.gophermap gophermap at /:syw_reponame
-// branch_list.gophermap gophermap at /:syw_reponame/branches
-// tag_list.gophermap gophermap at /:syw_reponame/tags
-// ref.gophermap gophermap at /:syw_reponame/refs/:ref
-// tree.gophermap gophermap at direcotry paths under /:syw_reponame/refs/:ref/tree/*path
+// repo_home.gophermap gophermap at /:repository
+// branch_list.gophermap gophermap at /:repository/branches
+// tag_list.gophermap gophermap at /:repository/tags
+// ref.gophermap gophermap at /:repository/refs/:ref
+// tree.gophermap gophermap at direcotry paths under /:repository/refs/:ref/tree/*path
// (file paths return the raw files without any template involved)
-// diffstat.gophertext plain text diffstat at /:syw_reponame/diffstat/:fromref/:toref
-// diff.gophertext plain text diff at /:syw_reponame/diff/:fromref/:toref
+// diffstat.gophertext plain text diffstat at /:repository/diffstat/:fromref/:toref
+// diff.gophertext plain text diff at /:repository/diff/:fromref/:toref
//
// Most of the templates above are rendered with an object with 6 fields:
// Ctx: the context.Context from the request
-// Repo: a *syw.Repository corresponding to <repodir>/:syw_reponame
+// Repo: a *syw.Repository corresponding to <repodir>/:repository
// Params: the map[string]string of the route parameters
// Host: the hostname of the running server
// Port: the port number of the running server