home: imp docs

annguyen0 · Jun 20, 2024 · d3c64e0 · d3c64e0
1 parent 7658c9b
commit d3c64e0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/internal/home/config.go b/internal/home/config.go
@@ -458,11 +458,13 @@ var config = &configuration{
 	},
 	Log: logSettings{
 		Enabled:    true,
-		Compress:   false,
-		LocalTime:  false,
+		File:       "",
 		MaxBackups: 0,
 		MaxSize:    100,
 		MaxAge:     3,
+		Compress:   false,
+		LocalTime:  false,
+		Verbose:    false,
 	},
 	OSConfig:      &osConfig{},
 	SchemaVersion: configmigrate.LastSchemaVersion,

diff --git a/internal/home/log.go b/internal/home/log.go
@@ -93,6 +93,8 @@ func getLogSettings(opts options) (ls *logSettings) {
 // separate method in order to configure logger before the actual configuration
 // is parsed and applied.
 func readLogSettings() (ls *logSettings) {
+	// TODO(s.chzhen):  Add a helper function that returns default parameters
+	// for this structure and for the global configuration structure [config].
 	conf := &configuration{
 		Log: logSettings{
 			// By default, it is true if the property does not exist.