docs: Move quickemu_conf manual to section 5 #1454
Conversation
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.
There was a problem hiding this comment.
This is fine. One slight concern is that Section 1 is by default searched before 5, so future changes might get overlooked if users do not explicitly select section 5 and have got an outdated copy left over in section 1. We should consider preemptively removing the old copy.
There was a problem hiding this comment.
One tiny omission: (ignore the pandoc upgrade ;-) )
diff --git a/docs/quickemu_conf.5 b/docs/quickemu_conf.5
index ca950b1..d07e135 100644
--- a/docs/quickemu_conf.5
+++ b/docs/quickemu_conf.5
@@ -1,6 +1,6 @@
-.\" Automatically generated by Pandoc 3.3
+.\" Automatically generated by Pandoc 3.4
.\"
-.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 DESCRIPTIONPlease either run the make clean ; make to rebuild or
tweak quickemu_conf.5 so it says it is in Section 5 not 1.
|
This change belongs in the second commit. Do you prefer a force-push upfront or an additional commit to squash into the second one afterwards? |
|
I'd prefer a forced push. I'm happy either way and appreciative of the contribution and consideration. |
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.
|
I should have known better, after all I edited the |
Description
As a configuration reference, it does not belong in section 1. To facilitate the implementation and avoid repetition between sections, pandoc make rules were simplified to accommodate the change.
I was planning to study quickemu and bring it to Fedora if it works with my use cases. I started with the documentation and next thing you know a yak shows up in a manual and I needed to get it out of the way to resume progress so I shaved it right away.
Type of change
Checklist:
On the last point, I technically made corresponding changes outside of the documentation.
I don't think this change needs new comments, but I'll let you be the judge of that.