Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Move quickemu_conf manual to section 5 #1454

Merged
merged 3 commits into from
Oct 4, 2024
+17 −19
Merged

docs: Move quickemu_conf manual to section 5 #1454

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05a3b34
docs: Simplify make rules for pandoc
dridi Sep 12, 2024
3630728
docs: Move quickemu_conf manual to section 5
dridi Sep 12, 2024
fa9f64c
docs: Remove potential quickemu_conf.1 leftover
dridi Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
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.
  • Loading branch information
@dridi
dridi committed Oct 3, 2024
commit 36307281139bfaee21049b8db1d27692f04063ae
9 changes: 5 additions & 4 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,17 @@ datadir := $(datarootdir)
mandir := $(datarootdir)/man
bindir := $(PREFIX)/bin

all: quickget.1 quickemu.1 quickemu_conf.1
all: quickget.1 quickemu.1 quickemu_conf.5

clean:
rm *.1
rm *.1 *.5

install_docs: all
install -d $(DESTDIR)$(mandir)/man1
install -d $(DESTDIR)$(mandir)/man5
install -m 644 quickget.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

philclifford marked this conversation as resolved.
Show resolved Hide resolved
# install -m 644 quickgui.1 $(DESTDIR)$(mandir)/man1

Expand All @@ -34,7 +35,7 @@ install: install_bins install_docs
uninstall::
rm -f $(DESTDIR)$(mandir)/man1/quickget.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)/quickemu
rm -f $(DESTDIR)$(bindir)/quickreport
Expand Down
4 changes: 2 additions & 2 deletions docs/pandoc-man.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PANDOC ?= pandoc
PANDOC_OPTIONS = -f gfm+definition_lists

.SUFFIXES: .1.md .1
.SUFFIXES: .1.md .1 .5.md .5

.1.md.1:
.1.md.1 .5.md.5:
$(PANDOC) --standalone $(PANDOC_OPTIONS) --to man -o $@ $<
2 changes: 1 addition & 1 deletion docs/quickemu.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1325,6 +1325,6 @@ Full sources at: \c
.UR https://github.com/quickemu-project/quickemu
.UE \c
.PP
quickemu_conf(1), quickget(1), quickgui(1)
quickemu_conf(5), quickget(1), quickgui(1)
.SH AUTHORS
Martin Wimpress.
2 changes: 1 addition & 1 deletion docs/quickemu.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -849,4 +849,4 @@ Submit bug reports online at:

Full sources at: <https://github.com/quickemu-project/quickemu>

quickemu_conf(1), quickget(1), quickgui(1)
quickemu_conf(5), quickget(1), quickgui(1)
2 changes: 1 addition & 1 deletion docs/quickemu_conf.1 → docs/quickemu_conf.5
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" 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
quickemu_conf \- Options and parameters in the quickemu <vm>.conf
.SH DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion docs/quickemu_conf.1.md → docs/quickemu_conf.5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ author: Martin Wimpress
date: August 2, 2024
footer: quickemu_conf
header: Quickemu Configuration Manual
section: 1
section: 5
title: QUICKEMU_CONF
---

Expand Down
2 changes: 1 addition & 1 deletion docs/quickget.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,6 +701,6 @@ Full sources at: \c
.UR https://github.com/quickemu-project/quickemu
.UE \c
.PP
quickemu(1), quickemu_conf(1), quickgui(1)
quickemu(1), quickemu_conf(5), quickgui(1)
.SH AUTHORS
Martin Wimpress.
2 changes: 1 addition & 1 deletion docs/quickget.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,4 +485,4 @@ Submit bug reports online at:

Full sources at: <https://github.com/quickemu-project/quickemu>

quickemu(1), quickemu_conf(1), quickgui(1)
quickemu(1), quickemu_conf(5), quickgui(1)
2 changes: 1 addition & 1 deletion package.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ stdenv.mkDerivation rec {
installPhase = ''
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

# spice-gtk needs to be put in suffix so that when virtualisation.spiceUSBRedirection
Expand Down