Rooba
/
perkeep
mirror of https://github.com/perkeep/perkeep.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

serverinit: add some more comments 

Change-Id: Ieddb7d47f2ad0e5873af434e174ca9687d0df6e3
This commit is contained in:
Brad Fitzpatrick 2018-03-22 22:14:05 -07:00
parent 6dcbe2ee9c
commit b0401489f1
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pkg/serverinit/serverinit.go
View File

@ -406,7 +406,12 @@ func handlerTypeWantsAuth(handlerType string) bool {
// A Config is the wrapper around a Perkeep JSON configuration file.
// Files on disk can be in either high-level or low-level format, but
// the Load function always returns the Config in its low-level format.
// the Load function always returns the Config in its low-level format
// (a.k.a. the "handler" format).
//
// TODO(bradfitz): document and/or link to the low-level format; for
// now you can see the high-level config format at https://perkeep.org/pkg/types/serverconfig/#Config
// and the the low-level format by running "camtool dumpconfig".
type Config struct {
jsonconfig.Obj
UIPath string // Not valid until after InstallHandlers
@ -438,6 +443,8 @@ func LoadFile(filename string) (*Config, error) {
return load(filename, nil)
}
// jsonFileImpl implements jsonconfig.File using a *bytes.Reader with
// the contents slurped into memory.
type jsonFileImpl struct {
*bytes.Reader
name string