about summary refs log tree commit diff stats
path: root/RELEASE_GUIDE.md
diff options
context:
space:
mode:
authorMichael Vetter <jubalh@iodoru.org>2020-12-04 17:29:31 +0100
committerMichael Vetter <jubalh@iodoru.org>2020-12-04 17:29:31 +0100
commit5e99a791e62d77e99b3e313947b8c1f00587a7e6 (patch)
treecaa4d8c735c9c3f81976a9ec3996578d67715781 /RELEASE_GUIDE.md
parent35aecd425fad6697e9cf72832cb287a156ec7942 (diff)
downloadprofani-tty-5e99a791e62d77e99b3e313947b8c1f00587a7e6.tar.gz
Create cmd to generate man pages for prof commands
`profanity mangen` will create for each command (`/account`, `/roster`)
an own manpage (`profanity-account.1`, `profanity-roster.1`)

See https://github.com/profanity-im/profanity/issues/1444

Needs some polishing formatting wise.
Diffstat (limited to 'RELEASE_GUIDE.md')
-rw-r--r--RELEASE_GUIDE.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/RELEASE_GUIDE.md b/RELEASE_GUIDE.md
index 2871d0f2..719a5969 100644
--- a/RELEASE_GUIDE.md
+++ b/RELEASE_GUIDE.md
@@ -15,6 +15,10 @@ Usually release candidates are tagged 0.6.0.rc1, 0.6.0.rc2 and tested for a week
 * Generate HTML docs (the docgen argument only works when package status is development)
     `./profanity docgen`
 
+* Generate manpages for profanity commands (the mangen argument only works when package status is development)
+    `./profanity mangen`
+  These files should be added to the docs subfolder and added to git whenever a command changes.
+
 * Determine if libprofanitys version needs to be [increased](https://github.com/profanity-im/profanity/issues/973)
 * Update plugin API docs (./apidocs/c and ./apidocs/python) need to run the `gen.sh` and commit the results to the website git repo
 * Update CHANGELOG