Stowage/caddy
2
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2025-10-19 07:43:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve godocs all around

Browse source 
These will be used in the new automated documentation system
This commit is contained in:
Matthew Holt 2019-12-23 12:45:35 -07:00
parent cbb405f6aa
commit 95ed603de7
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
26 changed files with 388 additions and 99 deletions
Download patch file Download diff file Expand all files Collapse all files

22
modules/caddyhttp/fileserver/matcher.go
View file

@ -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