File bash_completion.patch of Package warewulf4

Overview Repositories Revisions Requests Users Attributes Meta

File bash_completion.patch of Package warewulf4 (Revision d33a36ebe447d90efb4220965c709f0e)

Currently displaying revision d33a36ebe447d90efb4220965c709f0e , Show latest

From 6fc5bde305f84ec119f22ec36c79618f41fef69d Mon Sep 17 00:00:00 2001
From: Christian Goll <cgoll@suse.de>
Date: Fri, 16 Jul 2021 14:32:39 +0200
Subject: [PATCH 1/6] added binary to create bash completion

---
 cmd/bash_completion/bash_completion.go | 24 ++++++++++++++++++++++++
 internal/app/wwctl/root.go             |  8 ++++++++
 2 files changed, 32 insertions(+)
 create mode 100644 cmd/bash_completion/bash_completion.go

diff --git a/cmd/bash_completion/bash_completion.go b/cmd/bash_completion/bash_completion.go
new file mode 100644
index 0000000..59a8a27
--- /dev/null
+++ b/cmd/bash_completion/bash_completion.go
@@ -0,0 +1,24 @@
+// usage: ./bash_completion <FILE>
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/hpcng/warewulf/internal/wwctl"
+)
+
+func main() {
+	fh, err := os.Create(os.Args[1])
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	defer fh.Close()
+
+	if err := root.GenBashCompletion(fh); err != nil {
+		fmt.Println(err)
+		return
+	}
+}
diff --git a/internal/app/wwctl/root.go b/internal/app/wwctl/root.go
index e355cd3..cc3912e 100644
--- a/internal/app/wwctl/root.go
+++ b/internal/app/wwctl/root.go
@@ -1,6 +1,7 @@
 package wwctl
 
 import (
+  "io"
 	"github.com/hpcng/warewulf/internal/app/wwctl/configure"
 	"github.com/hpcng/warewulf/internal/app/wwctl/container"
 	"github.com/hpcng/warewulf/internal/app/wwctl/kernel"
@@ -59,3 +60,10 @@ func rootPersistentPreRunE(cmd *cobra.Command, args []string) error {
 	}
 	return nil
 }
+
+// GenBashCompletionFile
+func GenBashCompletion(w io.Writer) error {
+  return rootCmd.GenBashCompletion("out.sh")
+}
+
+
-- 
2.32.0

From e642beffa44fa0c43c97e7b6af8cba8db3891bfa Mon Sep 17 00:00:00 2001
From: Christian Goll <cgoll@suse.de>
Date: Fri, 16 Jul 2021 15:02:46 +0200
Subject: [PATCH 2/6] do not bail ot, when configs can't be read, still the
 bash_completion could be created

---
 internal/pkg/node/datastructure.go         | 3 ++-
 internal/pkg/warewulfconf/datastructure.go | 4 ++--
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/internal/pkg/node/datastructure.go b/internal/pkg/node/datastructure.go
index 406c656..8d7527c 100644
--- a/internal/pkg/node/datastructure.go
+++ b/internal/pkg/node/datastructure.go
@@ -101,7 +101,8 @@ func init() {
 		c, err := os.OpenFile(ConfigFile, os.O_RDWR|os.O_CREATE, 0644)
 		if err != nil {
 			wwlog.Printf(wwlog.ERROR, "Could not create new configuration file: %s\n", err)
-			os.Exit(1)
+      // just return silently, as init is also called for bash_completion
+      return
 		}
 
 		fmt.Fprintf(c, "nodeprofiles:\n")
diff --git a/internal/pkg/warewulfconf/datastructure.go b/internal/pkg/warewulfconf/datastructure.go
index da2dc0a..c47a08d 100644
--- a/internal/pkg/warewulfconf/datastructure.go
+++ b/internal/pkg/warewulfconf/datastructure.go
@@ -1,7 +1,6 @@
 package warewulfconf
 
 import (
-	"os"
 
 	"github.com/hpcng/warewulf/internal/pkg/util"
 	"github.com/hpcng/warewulf/internal/pkg/wwlog"
@@ -52,6 +51,7 @@ func init() {
 	//TODO: Check to make sure nodes.conf is found
 	if util.IsFile(ConfigFile) == false {
 		wwlog.Printf(wwlog.ERROR, "Configuration file not found: %s\n", ConfigFile)
-		os.Exit(1)
+    // fail silently as this also called by bash_completion
+    return
 	}
 }
-- 
2.32.0

From e32831ffd4615e33aa8a0035dd0381ea31b23d12 Mon Sep 17 00:00:00 2001
From: Christian Goll <cgoll@suse.de>
Date: Fri, 16 Jul 2021 15:47:25 +0200
Subject: [PATCH 3/6] build also bash_completion and execture it

---
 Makefile | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index 0ba63bb..d646c6b 100644
--- a/Makefile
+++ b/Makefile
@@ -15,7 +15,7 @@ GOLANGCI_LINT_VERSION := v1.31.0
 # built tags needed for wwbuild binary
 WW_BUILD_GO_BUILD_TAGS := containers_image_openpgp containers_image_ostree
 
-all: setup_tools vendor wwctl wwclient
+all: setup_tools vendor wwctl wwclient bash_completion
 
 # set the go tools into the tools bin.
 setup_tools: $(GO_TOOLS_BIN) $(GOLANGCI_LINT)
@@ -53,6 +53,8 @@ files: all
 	install -d -m 0755 $(DESTDIR)/etc/warewulf/
 	install -d -m 0755 $(DESTDIR)/etc/warewulf/ipxe
 	install -d -m 0755 $(DESTDIR)/var/lib/tftpboot/warewulf/ipxe/
+	install -d -m 0755 $(DESTDIR)/usr/share/bash-comletions/comletions
+	./bash_completion >$(DESTDIR)/usr/share/bash-comletions/comletions/wwctl
 	test -f $(DESTDIR)/etc/warewulf/warewulf.conf || install -m 644 etc/warewulf.conf $(DESTDIR)/etc/warewulf/
 	test -f $(DESTDIR)/etc/warewulf/hosts.tmpl || install -m 644 etc/hosts.tmpl $(DESTDIR)/etc/warewulf/
 	cp -r etc/dhcp $(DESTDIR)/etc/warewulf/
@@ -84,6 +86,9 @@ wwctl:
 wwclient:
 	cd cmd/wwclient; CGO_ENABLED=0 GOOS=linux go build -mod vendor -a -ldflags '-extldflags -static' -o ../../wwclient
 
+bash_completion:
+	cd cmd/bash_completion; go build -mod vendor -tags "$(WW_BUILD_GO_BUILD_TAGS)" -o ../../bash_completion
+
 dist: vendor
 	rm -rf _dist/warewulf-$(VERSION)
 	mkdir -p _dist/warewulf-$(VERSION)
-- 
2.32.0

From 8d8605f8b7231788f42a8c707625cc72afc7052f Mon Sep 17 00:00:00 2001
From: Christian Goll <cgoll@suse.de>
Date: Fri, 16 Jul 2021 15:49:12 +0200
Subject: [PATCH 4/6] fixed previous errors

---
 cmd/bash_completion/bash_completion.go | 5 ++---
 cmd/wwctl/main.go                      | 1 +
 internal/app/wwctl/root.go             | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/cmd/bash_completion/bash_completion.go b/cmd/bash_completion/bash_completion.go
index 59a8a27..2a300c8 100644
--- a/cmd/bash_completion/bash_completion.go
+++ b/cmd/bash_completion/bash_completion.go
@@ -4,8 +4,7 @@ package main
 import (
 	"fmt"
 	"os"
-
-	"github.com/hpcng/warewulf/internal/wwctl"
+	"github.com/hpcng/warewulf/internal/app/wwctl"
 )
 
 func main() {
@@ -17,7 +16,7 @@ func main() {
 
 	defer fh.Close()
 
-	if err := root.GenBashCompletion(fh); err != nil {
+	if err := wwctl.GenBashCompletion(fh); err != nil {
 		fmt.Println(err)
 		return
 	}
diff --git a/cmd/wwctl/main.go b/cmd/wwctl/main.go
index 0676131..e1e0f47 100644
--- a/cmd/wwctl/main.go
+++ b/cmd/wwctl/main.go
@@ -9,3 +9,4 @@ func main() {
 
 	root.Execute()
 }
+
diff --git a/internal/app/wwctl/root.go b/internal/app/wwctl/root.go
index cc3912e..7e810b1 100644
--- a/internal/app/wwctl/root.go
+++ b/internal/app/wwctl/root.go
@@ -63,7 +63,7 @@ func rootPersistentPreRunE(cmd *cobra.Command, args []string) error {
 
 // GenBashCompletionFile
 func GenBashCompletion(w io.Writer) error {
-  return rootCmd.GenBashCompletion("out.sh")
+  return rootCmd.GenBashCompletion(w)
 }
 
 
-- 
2.32.0

From fb9c771c2d8f96cc534ac3aa1821208fff21fe21 Mon Sep 17 00:00:00 2001
From: Christian Goll <cgoll@suse.de>
Date: Fri, 16 Jul 2021 15:52:32 +0200
Subject: [PATCH 5/6] using right command in Makefile

---
 Makefile | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Makefile b/Makefile
index d646c6b..b041f18 100644
--- a/Makefile
+++ b/Makefile
@@ -53,8 +53,8 @@ files: all
 	install -d -m 0755 $(DESTDIR)/etc/warewulf/
 	install -d -m 0755 $(DESTDIR)/etc/warewulf/ipxe
 	install -d -m 0755 $(DESTDIR)/var/lib/tftpboot/warewulf/ipxe/
-	install -d -m 0755 $(DESTDIR)/usr/share/bash-comletions/comletions
-	./bash_completion >$(DESTDIR)/usr/share/bash-comletions/comletions/wwctl
+	install -d -m 0755 $(DESTDIR)/etc/bash_completion.d/
+	./bash_completion  $(DESTDIR)/etc/bash_completion.d/warewulf
 	test -f $(DESTDIR)/etc/warewulf/warewulf.conf || install -m 644 etc/warewulf.conf $(DESTDIR)/etc/warewulf/
 	test -f $(DESTDIR)/etc/warewulf/hosts.tmpl || install -m 644 etc/hosts.tmpl $(DESTDIR)/etc/warewulf/
 	cp -r etc/dhcp $(DESTDIR)/etc/warewulf/
-- 
2.32.0

From 03677f0543cfa857f90cd4099047303e5ed6bd10 Mon Sep 17 00:00:00 2001
From: Christian Goll <cgoll@suse.de>
Date: Thu, 22 Jul 2021 11:53:58 +0200
Subject: [PATCH 6/6] automatic man page generation

---
 Makefile                   | 10 +++++++++-
 cmd/man_page/man_page.go   | 16 ++++++++++++++++
 internal/app/wwctl/root.go | 11 +++++++++--
 3 files changed, 34 insertions(+), 3 deletions(-)
 create mode 100644 cmd/man_page/man_page.go

diff --git a/Makefile b/Makefile
index b041f18..a8cb43c 100644
--- a/Makefile
+++ b/Makefile
@@ -15,7 +15,7 @@ GOLANGCI_LINT_VERSION := v1.31.0
 # built tags needed for wwbuild binary
 WW_BUILD_GO_BUILD_TAGS := containers_image_openpgp containers_image_ostree
 
-all: setup_tools vendor wwctl wwclient bash_completion
+all: setup_tools vendor wwctl wwclient bash_completion man_page
 
 # set the go tools into the tools bin.
 setup_tools: $(GO_TOOLS_BIN) $(GOLANGCI_LINT)
@@ -54,7 +54,10 @@ files: all
 	install -d -m 0755 $(DESTDIR)/etc/warewulf/ipxe
 	install -d -m 0755 $(DESTDIR)/var/lib/tftpboot/warewulf/ipxe/
 	install -d -m 0755 $(DESTDIR)/etc/bash_completion.d/
+	install -d -m 0755 $(DESTDIR)/usr/share/man/man1
 	./bash_completion  $(DESTDIR)/etc/bash_completion.d/warewulf
+	./man_page $(DESTDIR)/usr/share/man/man1
+	gzip $(DESTDIR)/usr/share/man/man1/wwctl*1
 	test -f $(DESTDIR)/etc/warewulf/warewulf.conf || install -m 644 etc/warewulf.conf $(DESTDIR)/etc/warewulf/
 	test -f $(DESTDIR)/etc/warewulf/hosts.tmpl || install -m 644 etc/hosts.tmpl $(DESTDIR)/etc/warewulf/
 	cp -r etc/dhcp $(DESTDIR)/etc/warewulf/
@@ -89,6 +92,9 @@ wwclient:
 bash_completion:
 	cd cmd/bash_completion; go build -mod vendor -tags "$(WW_BUILD_GO_BUILD_TAGS)" -o ../../bash_completion
 
+man_page:
+	cd cmd/man_page; go build -mod vendor -tags "$(WW_BUILD_GO_BUILD_TAGS)" -o ../../man_page
+
 dist: vendor
 	rm -rf _dist/warewulf-$(VERSION)
 	mkdir -p _dist/warewulf-$(VERSION)
@@ -102,6 +108,8 @@ clean:
 	rm -f wwctl
 	rm -rf _dist
 	rm -f warewulf-$(VERSION).tar.gz
+	rm -f bash_completion
+	rm -f man_page
 
 install: files
 
diff --git a/cmd/man_page/man_page.go b/cmd/man_page/man_page.go
new file mode 100644
index 0000000..45d4241
--- /dev/null
+++ b/cmd/man_page/man_page.go
@@ -0,0 +1,16 @@
+// usage: ./bash_completion <FILE>
+package main
+
+import (
+	"fmt"	
+	"os"
+	"github.com/hpcng/warewulf/internal/app/wwctl"
+)
+
+func main() {
+	
+	if err := wwctl.GenManTree(os.Args[1]); err != nil {
+		fmt.Println(err)
+		return
+	}
+}
diff --git a/internal/app/wwctl/root.go b/internal/app/wwctl/root.go
index 7e810b1..c6d9023 100644
--- a/internal/app/wwctl/root.go
+++ b/internal/app/wwctl/root.go
@@ -1,7 +1,7 @@
 package wwctl
 
 import (
-  "io"
+  	"io"
 	"github.com/hpcng/warewulf/internal/app/wwctl/configure"
 	"github.com/hpcng/warewulf/internal/app/wwctl/container"
 	"github.com/hpcng/warewulf/internal/app/wwctl/kernel"
@@ -13,6 +13,7 @@ import (
 	"github.com/hpcng/warewulf/internal/app/wwctl/server"
 	"github.com/hpcng/warewulf/internal/pkg/wwlog"
 	"github.com/spf13/cobra"
+	"github.com/spf13/cobra/doc"
 )
 
 var (
@@ -66,4 +67,10 @@ func GenBashCompletion(w io.Writer) error {
   return rootCmd.GenBashCompletion(w)
 }
 
-
+func GenManTree(fileName string) error{
+	header := &doc.GenManHeader{
+		Title: "MINE",
+		Section: "1",
+	}
+	return doc.GenManTree(rootCmd,header,fileName)
+}
-- 
2.32.0

Places

File bash_completion.patch of Package warewulf4 (Revision d33a36ebe447d90efb4220965c709f0e)

Places