lxddoc: Within a config group, alphabetically sort the config options

Signed-off-by: Gabriel Mougard <[email protected]>

lxd/config/generate/lxddoc.go

@@ -10,6 +10,7 @@ import (
 	"os"
 	"path/filepath"
 	"regexp"
+	"sort"
 	"strconv"
 	"strings"
 	"time"
@@ -191,7 +192,38 @@ func parse(path string, outputYAMLPath string, excludedPaths []string) (*doc, er
 		return nil, err
 	}
 
-	yamlDoc.Configs = projectEntries
+	// Within each group, alphabetically sort the entries by key (config option key)
+	orderedProjectEntries := make(map[string][]any, len(projectEntries))
+	for groupKey, entries := range projectEntries {
+		var sortedConfigOptionKeysPerGroup []string
+		for _, configEntry := range entries {
+			c := configEntry.(map[string]any)
+			for k := range c {
+				sortedConfigOptionKeysPerGroup = append(sortedConfigOptionKeysPerGroup, k)
+			}
+		}
+
+		sort.Strings(sortedConfigOptionKeysPerGroup)
+		for _, configOptionKey := range sortedConfigOptionKeysPerGroup {
+			for _, configEntry := range entries {
+				c := configEntry.(map[string]any)
+				for k := range c {
+					if k == configOptionKey {
+						_, ok := orderedProjectEntries[groupKey]
+						if !ok {
+							orderedProjectEntries[groupKey] = []any{c}
+						} else {
+							orderedProjectEntries[groupKey] = append(orderedProjectEntries[groupKey], c)
+						}
+
+						break
+					}
+				}
+			}
+		}
+	}
+
+	yamlDoc.Configs = orderedProjectEntries
 	data, err := yaml.Marshal(yamlDoc)
 	if err != nil {
 		return nil, fmt.Errorf("Error while marshaling project documentation: %v", err)