Page MenuHomeFreeBSD

mandoc: Don't brand Volume titles
AcceptedPublic

Authored by me_cameronkatri.com on Oct 4 2021, 6:53 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Oct 1, 5:34 AM
Unknown Object (File)
Wed, Sep 30, 6:48 PM
Unknown Object (File)
Wed, Sep 30, 1:12 PM
Unknown Object (File)
Fri, Sep 25, 8:54 PM
Unknown Object (File)
Thu, Sep 24, 3:40 AM
Unknown Object (File)
Wed, Sep 16, 11:04 PM
Unknown Object (File)
Mon, Sep 14, 8:19 PM
Unknown Object (File)
Sat, Sep 12, 5:24 PM

Details

Summary

msec.in is provided to add custom volumes, like 3lua, or to use a
different convention, not to brand. The operation system is shown in the
footer anyways.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 41949
Build 38837: arc lint + arc unit

Event Timeline

mandoc 1.14.6 was just released on September 23 (https://mandoc.bsd.lv/NEWS), but Phabricator isn't really suited to submit patches for vendor updates, so a committer will have to do that.

ziaee added a subscriber: ziaee.

Currently the OS is shown in manpage header and footer. The patch would make it shown only in the footer, and make the header the same as on other OSes. Should we do this, or close this revision?

Currently the OS is shown in manpage header and footer. The patch would make it shown only in the footer, and make the header the same as on other OSes. Should we do this, or close this revision?

I would keep the FreeBSD name.

0mp added a subscriber: 0mp.

My bikeshed color: ideally, I'd keep FreeBSD for the base manual pages and I'd agree to drop it for those coming from ports. This is not feasible though.

Considering the rationale in the linked email, I'd be alright with removing our branding and aligning with upstream.

This revision is now accepted and ready to land.Sat, Sep 19, 3:22 PM
This revision now requires review to proceed.Sat, Oct 3, 8:50 AM

Same for me, I'll keep the FreeBSD name

so, after this patch mandoc output will look like groff? Fine by me.

zcat /usr/share/man/man1/cat.1.gz |nroff -mdoc
CAT(1)                       General Commands Manual                      CAT(1)
zcat /usr/share/man/man1/cat.1.gz |mandoc
CAT(1)                  FreeBSD General Commands Manual                 CAT(1)
ziaee accepted this revision.EditedSat, Oct 3, 4:23 PM

so, after this patch mandoc output will look like groff? Fine by me.

It will not just align with groff, but also heirloom-doctools, man-db, man.cgi, and mandoc from ports. It also solves the bug where there can be conflicting header and footer if formatting manual pages for other operating systems, or portable software compilations. The FreeBSD name here is a bug because mdoc has a separate mechanism for declaring the OS name which can be set by the page.

Ideally, manual pages formatted by the compiler in base should be fully featured, and identical to manual pages formatted any other way.

This revision is now accepted and ready to land.Sat, Oct 3, 4:23 PM