Bug 273248 - x11/kitty: kitty.conf(5) manual page improvement
Summary: x11/kitty: kitty.conf(5) manual page improvement
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Nicola Vitale
URL: https://www.freshports.org/x11/kitty/
Keywords:
Depends on:
Blocks:
 
Reported: 2023-08-20 20:27 UTC by Graham Perrin
Modified: 2023-08-26 08:22 UTC (History)
0 users

See Also:
bugzilla: maintainer-feedback? (nivit)

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin 2023-08-20 20:27:31 UTC 
<https://man.freebsd.org/cgi/man.cgi?query=glob&apropos=1> (partial screenshot: <https://user-images.githubusercontent.com/192271/260857832-927f7a50-a95a-4fb0-9092-d39d0e52f1b1.png>) revealed problems with a few manual pages. 

Upstream <https://github.com/kovidgoyal/kitty/commit/f299549dba3e4ae0232e6df5fa74126c9f20b11a>: 

> Improve sectioning in kitty.conf manpage · kovidgoyal/kitty@f299549
Comment 1 commit-hook freebsd_committer freebsd_triage 2023-08-26 08:10:57 UTC 
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/ports/commit/?id=b3504b217df4de1ae0b48e4619dac25694c7e42a

commit b3504b217df4de1ae0b48e4619dac25694c7e42a
Author:     Nicola Vitale <nivit@FreeBSD.org>
AuthorDate: 2023-08-26 08:01:56 +0000
Commit:     Nicola Vitale <nivit@FreeBSD.org>
CommitDate: 2023-08-26 08:01:56 +0000

    x11/kitty: kitty.conf(5) manual page improvement

    Add an OVERVIEW section to that manpage, so that the NAME section has
    only few words. See for example the output when visiting

    https://man.freebsd.org/cgi/man.cgi?query=kitty.conf&apropos=1

    Current rendering:

    https://user-images.githubusercontent.com/192271/260857832-927f7a50-a95a-4fb0-9092-d39d0e52f1b1.png

    PR:             273248
    Reported by:    Graham Perrin <grahamperrin@gmail.com>

 x11/kitty/files/patch-docs_conf.py        | 11 ++++++++++-
 x11/kitty/files/patch-docs_conf.rst (new) | 18 ++++++++++++++++++
 2 files changed, 28 insertions(+), 1 deletion(-)
Comment 2 Nicola Vitale freebsd_committer freebsd_triage 2023-08-26 08:22:27 UTC 
Committed. Thank you for the PR!