generate-config: Rename from incus-doc

Signed-off-by: Lucas Bremgartner <[email protected]>

Author: breml

Makefile

@@ -143,8 +143,8 @@ endif
 .PHONY: update-metadata
 update-metadata: build
 	@echo "Generating golang documentation metadata"
-	cd cmd/generate-config && CGO_ENABLED=0 $(GO) build -o $(GOPATH)/bin/incus-doc
-	$(GOPATH)/bin/incus-doc . --json ./internal/server/metadata/configuration.json --txt ./doc/config_options.txt
+	cd cmd/generate-config && CGO_ENABLED=0 $(GO) build -o $(GOPATH)/bin/generate-config
+	$(GOPATH)/bin/generate-config . --json ./internal/server/metadata/configuration.json --txt ./doc/config_options.txt
 
 .PHONY: doc-setup
 doc-setup: client

cmd/generate-config/README.md

@@ -1,13 +1,13 @@
-# incus-doc
+# generate-config
 
 A small CLI to parse comments in a Golang codebase meant to be used for a documentation tool (like Sphinx for example).
 
 It parses the comments from the AST and extracts their documentation.
 
 # Usage
 
-    $ incus-doc -h
-    Usage of incus-doc:
+    $ generate-config -h
+    Usage of generate-config:
     -e value
         Path that will be excluded from the process
 
@@ -78,7 +78,7 @@ A comment is formatted this way:
 
 The go-swagger spec from source generator can only handles `swagger:meta` (global file/package level documentation), `swagger:route` (API endpoints), `swagger:params` (function parameters), `swagger:operation` (method documentation), `swagger:response` (API response content documentation), `swagger:model` (struct documentation) generation. In our use case, we would want a config variable spec generator that can bundle any key-value data pairs alongside metadata to build a sense of hierarchy and identity (we want to associate a unique key to each gendoc comment group that will also be displayed in the generated documentation)
 
-In a swagger fashion, `incus-doc` can associate metadata key-value pairs (here for example, `group` and `key`) to data key-value pairs. As a result, it can generate a YAML tree out of the code documentation and also a Markdown document.
+In a swagger fashion, `generate-config` can associate metadata key-value pairs (here for example, `group` and `key`) to data key-value pairs. As a result, it can generate a YAML tree out of the code documentation and also a Markdown document.
 
 ## Output
 

cmd/generate-config/incus_doc.go

@@ -296,7 +296,7 @@ func writeDocFile(inputJSONPath, outputTxtPath string) error {
 
 	sortedEntityKeys := getSortedKeysFromMap(jsonDoc.Configs)
 	// create a string buffer
-	buffer := bytes.NewBufferString("// Code generated by incus-doc; DO NOT EDIT.\n\n")
+	buffer := bytes.NewBufferString("// Code generated by generate-config from the incus project; DO NOT EDIT.\n\n")
 	for _, entityKey := range sortedEntityKeys {
 		entityEntries := jsonDoc.Configs[entityKey]
 		sortedGroupKeys := getSortedKeysFromMap(entityEntries.(map[string]any))

cmd/generate-config/incus_doc_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-// Test the alphabetical sorting of a `incus-doc` JSON structure.
+// Test the alphabetical sorting of a `generate-config` JSON structure.
 func TestJSONSorted(t *testing.T) {
 	projectEntries := make(map[string]any)
 	projectEntries["entityKey1"] = map[string]any{

cmd/generate-config/main.go

@@ -12,9 +12,9 @@ var exclude []string
 var jsonOutput string
 var txtOutput string
 var rootCmd = &cobra.Command{
-	Use:   "incus-doc",
-	Short: "incus-doc - a simple tool to generate documentation for Incus",
-	Long:  "incus-doc - a simple tool to generate documentation for Incus. It outputs a YAML and a Markdown file that contain the content of all `gendoc:generate` statements in the project.",
+	Use:   "generate-config",
+	Short: "generate-config - a simple tool to generate documentation for Incus",
+	Long:  "generate-config - a simple tool to generate documentation for Incus. It outputs a YAML and a Markdown file that contain the content of all `gendoc:generate` statements in the project.",
 	Args:  cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		if len(args) != 1 {
@@ -42,9 +42,9 @@ func main() {
 	rootCmd.Flags().StringVarP(&txtOutput, "txt", "t", "", "Output TXT file containing the generated documentation")
 	err := rootCmd.Execute()
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "incus-doc failed: %v", err)
+		fmt.Fprintf(os.Stderr, "generate-config failed: %v", err)
 		os.Exit(1)
 	}
 
-	log.Println("incus-doc finished successfully")
+	log.Println("generate-config finished successfully")
 }

doc/config_options.txt

@@ -1,4 +1,4 @@
-// Code generated by incus-doc; DO NOT EDIT.
+// Code generated by generate-config from the incus project; DO NOT EDIT.
 
 <!-- config group cluster-cluster start -->
 ```{config:option} scheduler.instance cluster-cluster