RomanNum3ral
/
quickemu
mirror of https://github.com/quickemu-project/quickemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Move quickemu_conf manual to section 5 (#1454) 

* docs: Simplify make rules for pandoc

This removes a --standalone duplicate and counter-productive
indirections like $(MANSECTION) because it prevents having more
than one and docs/Makefile hardcodes the section anyway.

* docs: Move quickemu_conf manual to section 5

Where it technically belongs... With the new make rules for pandoc, it's
actually much easier to manage manuals in several sections without much
overhead.

* docs: Remove potential quickemu_conf.1 leftover
This commit is contained in:
Dridi Boukelmoune 2024-10-04 10:35:36 +00:00 committed by GitHub
parent 002e366552
commit 84595dc32f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 17 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/Makefile
View File

@ -9,16 +9,18 @@ datadir := $(datarootdir)
mandir := $(datarootdir)/man mandir := $(datarootdir)/man
bindir := $(PREFIX)/bin bindir := $(PREFIX)/bin
all: quickget.1 quickemu.1 quickemu_conf.1 all: quickget.1 quickemu.1 quickemu_conf.5
clean: clean:
rm *.1 rm *.1 *.5
install_docs: all install_docs: all
install -d $(DESTDIR)$(mandir)/man1 install -d $(DESTDIR)$(mandir)/man1
install -d $(DESTDIR)$(mandir)/man5
install -m 644 quickget.1 $(DESTDIR)$(mandir)/man1 install -m 644 quickget.1 $(DESTDIR)$(mandir)/man1
install -m 644 quickemu.1 $(DESTDIR)$(mandir)/man1 install -m 644 quickemu.1 $(DESTDIR)$(mandir)/man1
install -m 644 quickemu_conf.1 $(DESTDIR)$(mandir)/man1 install -m 644 quickemu_conf.5 $(DESTDIR)$(mandir)/man5
rm -f $(DESTDIR)$(mandir)/man1/quickemu_conf.1
# install -m 644 quickgui.1 $(DESTDIR)$(mandir)/man1 # install -m 644 quickgui.1 $(DESTDIR)$(mandir)/man1
@ -34,7 +36,7 @@ install: install_bins install_docs
uninstall:: uninstall::
rm -f $(DESTDIR)$(mandir)/man1/quickget.1 rm -f $(DESTDIR)$(mandir)/man1/quickget.1
rm -f $(DESTDIR)$(mandir)/man1/quickemu.1 rm -f $(DESTDIR)$(mandir)/man1/quickemu.1
rm -f $(DESTDIR)$(mandir)/man1/quickemu_conf.1 rm -f $(DESTDIR)$(mandir)/man5/quickemu_conf.5
rm -f $(DESTDIR)$(bindir)/quickget rm -f $(DESTDIR)$(bindir)/quickget
rm -f $(DESTDIR)$(bindir)/quickemu rm -f $(DESTDIR)$(bindir)/quickemu
rm -f $(DESTDIR)$(bindir)/quickreport rm -f $(DESTDIR)$(bindir)/quickreport

12
docs/pandoc-man.mk
View File

@ -1,11 +1,7 @@
PANDOC ?= pandoc PANDOC ?= pandoc
PANDOC_OPTIONS = -f gfm+definition_lists
MANSECTION ?= 1 .SUFFIXES: .1.md .1 .5.md .5
PANDOC_OPTIONS=-f gfm+definition_lists --standalone .1.md.1 .5.md.5:
$(PANDOC) --standalone $(PANDOC_OPTIONS) --to man -o $@ $<
MANPAGE.md = $(PANDOC) --standalone $(PANDOC_OPTIONS) --to man
%.$(MANSECTION): %.$(MANSECTION).md
$(MANPAGE.md) $< -o $@

2
docs/quickemu.1
View File

@ -1325,6 +1325,6 @@ Full sources at: \c
.UR https://github.com/quickemu-project/quickemu .UR https://github.com/quickemu-project/quickemu
.UE \c .UE \c
.PP .PP
quickemu_conf(1), quickget(1), quickgui(1) quickemu_conf(5), quickget(1), quickgui(1)
.SH AUTHORS .SH AUTHORS
Martin Wimpress. Martin Wimpress.

2
docs/quickemu.1.md
View File

@ -849,4 +849,4 @@ Submit bug reports online at:
Full sources at: <https://github.com/quickemu-project/quickemu> Full sources at: <https://github.com/quickemu-project/quickemu>
quickemu_conf(1), quickget(1), quickgui(1) quickemu_conf(5), quickget(1), quickgui(1)

2
docs/quickemu_conf.1 → docs/quickemu_conf.5
View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.3 .\" Automatically generated by Pandoc 3.3
.\" .\"
.TH "QUICKEMU_CONF" "1" "August 2, 2024" "quickemu_conf" "Quickemu Configuration Manual" .TH "QUICKEMU_CONF" "5" "August 2, 2024" "quickemu_conf" "Quickemu Configuration Manual"
.SH NAME .SH NAME
quickemu_conf \- Options and parameters in the quickemu <vm>.conf quickemu_conf \- Options and parameters in the quickemu <vm>.conf
.SH DESCRIPTION .SH DESCRIPTION

2
docs/quickemu_conf.1.md → docs/quickemu_conf.5.md
View File

@ -3,7 +3,7 @@ author: Martin Wimpress
date: August 2, 2024 date: August 2, 2024
footer: quickemu_conf footer: quickemu_conf
header: Quickemu Configuration Manual header: Quickemu Configuration Manual
section: 1 section: 5
title: QUICKEMU_CONF title: QUICKEMU_CONF
--- ---

2
docs/quickget.1
View File

@ -701,6 +701,6 @@ Full sources at: \c
.UR https://github.com/quickemu-project/quickemu .UR https://github.com/quickemu-project/quickemu
.UE \c .UE \c
.PP .PP
quickemu(1), quickemu_conf(1), quickgui(1) quickemu(1), quickemu_conf(5), quickgui(1)
.SH AUTHORS .SH AUTHORS
Martin Wimpress. Martin Wimpress.

2
docs/quickget.1.md
View File

@ -485,4 +485,4 @@ Submit bug reports online at:
Full sources at: <https://github.com/quickemu-project/quickemu> Full sources at: <https://github.com/quickemu-project/quickemu>
quickemu(1), quickemu_conf(1), quickgui(1) quickemu(1), quickemu_conf(5), quickgui(1)

2
package.nix
View File

@ -81,7 +81,7 @@ stdenv.mkDerivation rec {
installPhase = '' installPhase = ''
runHook preInstall runHook preInstall
installManPage docs/quickget.1 docs/quickemu.1 docs/quickemu_conf.1 installManPage docs/quickget.1 docs/quickemu.1 docs/quickemu_conf.5
install -Dm755 -t "$out/bin" chunkcheck quickemu quickget quickreport install -Dm755 -t "$out/bin" chunkcheck quickemu quickget quickreport
# spice-gtk needs to be put in suffix so that when virtualisation.spiceUSBRedirection # spice-gtk needs to be put in suffix so that when virtualisation.spiceUSBRedirection