diff options
| author | Matthew Holt <mholt@users.noreply.github.com> | 2019-12-23 12:45:35 -0700 |
|---|---|---|
| committer | Matthew Holt <mholt@users.noreply.github.com> | 2019-12-23 12:45:35 -0700 |
| commit | 95ed603de79c66ff76bfe7e42986a2fc8c7a1fa4 (patch) | |
| tree | 1a788b8eba98f0c2e69e5816bac9c7cc09aca96f /modules/caddyhttp/fileserver/matcher.go | |
| parent | cbb405f6aaee046c9de9ffb4f07ca824d9eedeb1 (diff) | |
Improve godocs all around
These will be used in the new automated documentation system
Diffstat (limited to 'modules/caddyhttp/fileserver/matcher.go')
| -rw-r--r-- | modules/caddyhttp/fileserver/matcher.go | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/modules/caddyhttp/fileserver/matcher.go b/modules/caddyhttp/fileserver/matcher.go index 13cb60a..5ca97f2 100644 --- a/modules/caddyhttp/fileserver/matcher.go +++ b/modules/caddyhttp/fileserver/matcher.go @@ -46,7 +46,13 @@ type MatchFile struct { // placeholders. TryFiles []string `json:"try_files,omitempty"` - // How to choose a file in TryFiles. + // How to choose a file in TryFiles. Can be: + // + // - first_exist + // - smallest_size + // - largest_size + // - most_recently_modified + // // Default is first_exist. TryPolicy string `json:"try_policy,omitempty"` } @@ -64,7 +70,7 @@ func (MatchFile) CaddyModule() caddy.ModuleInfo { // file { // root <path> // try_files <files...> -// try_policy first_exist|smallest_size|largest_size|most_recent_modified +// try_policy first_exist|smallest_size|largest_size|most_recently_modified // } // func (m *MatchFile) UnmarshalCaddyfile(d *caddyfile.Dispenser) error { @@ -107,7 +113,7 @@ func (m MatchFile) Validate() error { tryPolicyFirstExist, tryPolicyLargestSize, tryPolicySmallestSize, - tryPolicyMostRecentMod: + tryPolicyMostRecentlyMod: default: return fmt.Errorf("unknown try policy %s", m.TryPolicy) } @@ -187,7 +193,7 @@ func (m MatchFile) selectFile(r *http.Request) (rel, abs string, matched bool) { } return smallestSuffix, smallestFilename, true - case tryPolicyMostRecentMod: + case tryPolicyMostRecentlyMod: var recentDate time.Time var recentFilename string var recentSuffix string @@ -238,10 +244,10 @@ func strictFileExists(file string) bool { } const ( - tryPolicyFirstExist = "first_exist" - tryPolicyLargestSize = "largest_size" - tryPolicySmallestSize = "smallest_size" - tryPolicyMostRecentMod = "most_recent_modified" + tryPolicyFirstExist = "first_exist" + tryPolicyLargestSize = "largest_size" + tryPolicySmallestSize = "smallest_size" + tryPolicyMostRecentlyMod = "most_recently_modified" ) // Interface guards |