kelvin/warewulf
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

automatic man page generation

Browse Source
This commit is contained in:
Christian Goll
2021-07-22 11:53:58 +02:00
parent b27951b59f
commit 8d5162f88a
3 changed files with 34 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Makefile
View File

@@ -15,7 +15,7 @@ GOLANGCI_LINT_VERSION := v1.31.0
# built tags needed for wwbuild binary # built tags needed for wwbuild binary
WW_BUILD_GO_BUILD_TAGS := containers_image_openpgp containers_image_ostree 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. # set the go tools into the tools bin.
setup_tools: $(GO_TOOLS_BIN) $(GOLANGCI_LINT) 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)/etc/warewulf/ipxe
install -d -m 0755 $(DESTDIR)/var/lib/tftpboot/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)/etc/bash_completion.d/
install -d -m 0755 $(DESTDIR)/usr/share/man/man1
./bash_completion $(DESTDIR)/etc/bash_completion.d/warewulf ./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/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/ test -f $(DESTDIR)/etc/warewulf/hosts.tmpl || install -m 644 etc/hosts.tmpl $(DESTDIR)/etc/warewulf/
cp -r etc/dhcp $(DESTDIR)/etc/warewulf/ cp -r etc/dhcp $(DESTDIR)/etc/warewulf/
@@ -89,6 +92,9 @@ wwclient:
bash_completion: bash_completion:
cd cmd/bash_completion; go build -mod vendor -tags "$(WW_BUILD_GO_BUILD_TAGS)" -o ../../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 dist: vendor
rm -rf _dist/warewulf-$(VERSION) rm -rf _dist/warewulf-$(VERSION)
mkdir -p _dist/warewulf-$(VERSION) mkdir -p _dist/warewulf-$(VERSION)
@@ -102,6 +108,8 @@ clean:
rm -f wwctl rm -f wwctl
rm -rf _dist rm -rf _dist
rm -f warewulf-$(VERSION).tar.gz rm -f warewulf-$(VERSION).tar.gz
rm -f bash_completion
rm -f man_page
install: files install: files

16
cmd/man_page/man_page.go Normal file
View File

@@ -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
}
}

11
internal/app/wwctl/root.go
View File

@@ -1,7 +1,7 @@
package wwctl package wwctl
import ( import (
"io" "io"
"github.com/hpcng/warewulf/internal/app/wwctl/configure" "github.com/hpcng/warewulf/internal/app/wwctl/configure"
"github.com/hpcng/warewulf/internal/app/wwctl/container" "github.com/hpcng/warewulf/internal/app/wwctl/container"
"github.com/hpcng/warewulf/internal/app/wwctl/kernel" "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/app/wwctl/server"
"github.com/hpcng/warewulf/internal/pkg/wwlog" "github.com/hpcng/warewulf/internal/pkg/wwlog"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
) )
var ( var (
@@ -66,4 +67,10 @@ func GenBashCompletion(w io.Writer) error {
return rootCmd.GenBashCompletion(w) return rootCmd.GenBashCompletion(w)
} }
func GenManTree(fileName string) error{
header := &doc.GenManHeader{
Title: "MINE",
Section: "1",
}
return doc.GenManTree(rootCmd,header,fileName)
}