mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-12 01:13:10 -06:00
Code Issues Packages Projects Releases Wiki Activity

Document what the purpose of the version field is

Browse source
This commit is contained in:
Mark Haines 2017-06-16 15:35:13 +01:00
parent c4d34db748
commit 14a57a7d81
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/github.com/matrix-org/dendrite/common/config/config.go
View file

@ -36,6 +36,11 @@ const Version = "v0"
// Relative paths are resolved relative to the current working directory // Relative paths are resolved relative to the current working directory
type Dendrite struct { type Dendrite struct {
// The version of the configuration file. // The version of the configuration file.
// If the version in a file doesn't match the current dendrite config
// version then we can give a clear error message telling the user
// to update their config file to the current version.
// The version of the file should only be different if there has
// been a breaking change to the config file format.
Version string `yaml:"version"` Version string `yaml:"version"`
// The configuration required for a matrix server. // The configuration required for a matrix server.