From 14a57a7d81b3b36922c89f3b81e5e7ca7eb07001 Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Fri, 16 Jun 2017 15:35:13 +0100 Subject: [PATCH] Document what the purpose of the version field is --- src/github.com/matrix-org/dendrite/common/config/config.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/github.com/matrix-org/dendrite/common/config/config.go b/src/github.com/matrix-org/dendrite/common/config/config.go index 89c4a1703..e06f894a9 100644 --- a/src/github.com/matrix-org/dendrite/common/config/config.go +++ b/src/github.com/matrix-org/dendrite/common/config/config.go @@ -36,6 +36,11 @@ const Version = "v0" // Relative paths are resolved relative to the current working directory type Dendrite struct { // 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"` // The configuration required for a matrix server.