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

Improve the generation of man pages

Browse Source 
Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
Jonathon Anderson
2023-08-10 06:56:45 -06:00
parent f375ff32cb
commit 1fdd3742c3
2 changed files with 10 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.gitignore vendored
View File

@@ -10,7 +10,6 @@
/wwclient /wwclient
/wwctl /wwctl
/bash_completion /bash_completion
/man_page
/config_defaults /config_defaults
/update_configuration /update_configuration
/wwapic /wwapic
@@ -19,9 +18,9 @@
/print_defaults /print_defaults
# other created files # other created files
/man_pages /docs/man/man1/*.1.gz
/docs/man/man5/*.5.gz
/bash_completion.d /bash_completion.d
/usr/share/man/man1/
/etc/bash_completion.d/ /etc/bash_completion.d/
warewulf.spec warewulf.spec
internal/pkg/buildconfig/setconfigs.go internal/pkg/buildconfig/setconfigs.go

18
Makefile
View File

@@ -100,8 +100,8 @@ install: all
install -m 0644 include/systemd/warewulfd.service $(DESTDIR)$(SYSTEMDDIR) install -m 0644 include/systemd/warewulfd.service $(DESTDIR)$(SYSTEMDDIR)
install -m 0644 LICENSE.md $(DESTDIR)$(WWDOCDIR) install -m 0644 LICENSE.md $(DESTDIR)$(WWDOCDIR)
./wwctl --warewulfconf etc/warewulf.conf genconfig completions > $(DESTDIR)$(BASHCOMPDIR)/wwctl ./wwctl --warewulfconf etc/warewulf.conf genconfig completions > $(DESTDIR)$(BASHCOMPDIR)/wwctl
cp man_pages/*.1* $(DESTDIR)$(MANDIR)/man1/ for f in docs/man/man1/*.1.gz; do install -m 0644 $$f $(DESTDIR)$(MANDIR)/man1/; done
cp man_pages/*.5* $(DESTDIR)$(MANDIR)/man5/ for f in docs/man/man5/*.5.gz; do install -m 0644 $$f $(DESTDIR)$(MANDIR)/man5/; done
install -m 0644 staticfiles/README-ipxe.md $(DESTDIR)$(WWDATADIR)/ipxe install -m 0644 staticfiles/README-ipxe.md $(DESTDIR)$(WWDATADIR)/ipxe
install -m 0644 staticfiles/arm64.efi $(DESTDIR)$(WWDATADIR)/ipxe install -m 0644 staticfiles/arm64.efi $(DESTDIR)$(WWDATADIR)/ipxe
install -m 0644 staticfiles/x86_64.efi $(DESTDIR)$(WWDATADIR)/ipxe install -m 0644 staticfiles/x86_64.efi $(DESTDIR)$(WWDATADIR)/ipxe
@@ -121,11 +121,12 @@ wwclient: config vendor $(WWCLIENT_DEPS)
cd cmd/wwclient; CGO_ENABLED=0 GOOS=linux go build -mod vendor -a -ldflags "-extldflags -static" \ cd cmd/wwclient; CGO_ENABLED=0 GOOS=linux go build -mod vendor -a -ldflags "-extldflags -static" \
-o ../../wwclient -o ../../wwclient
man_pages: wwctl .PHONY: man_pages
install -d man_pages man_pages: wwctl $(wildcard docs/man/man5/*.5)
./wwctl --emptyconf genconfig man man_pages mkdir -p docs/man/man1
cp docs/man/man5/*.5 ./man_pages/ ./wwctl --emptyconf genconfig man docs/man/man1
cd man_pages; for i in wwctl*1 *.5; do gzip --force $$i; echo -n "$$i "; done; echo gzip --force docs/man/man1/*.1
gzip --force --keep docs/man/man5/*.5
update_configuration: vendor cmd/update_configuration/update_configuration.go update_configuration: vendor cmd/update_configuration/update_configuration.go
cd cmd/update_configuration && go build \ cd cmd/update_configuration && go build \
@@ -187,10 +188,8 @@ contclean:
rm -f include/systemd/warewulfd.service rm -f include/systemd/warewulfd.service
rm -f internal/pkg/buildconfig/setconfigs.go rm -f internal/pkg/buildconfig/setconfigs.go
rm -f internal/pkg/config/buildconfig.go rm -f internal/pkg/config/buildconfig.go
rm -f man_page
rm -f print_defaults rm -f print_defaults
rm -f update_configuration rm -f update_configuration
rm -f usr/share/man/man1/
rm -f warewulf.spec rm -f warewulf.spec
rm -f warewulf-*.tar.gz rm -f warewulf-*.tar.gz
rm -f wwapic rm -f wwapic
@@ -204,7 +203,6 @@ contclean:
rm -rf .dist/ rm -rf .dist/
rm -rf _dist/ rm -rf _dist/
rm -rf etc/bash_completion.d/ rm -rf etc/bash_completion.d/
rm -rf man_pages
rm -rf userdocs/_* rm -rf userdocs/_*
rm -rf userdocs/reference/* rm -rf userdocs/reference/*