Bug 259790 - cftmerge(1) manual page does not explain what a CTF is
Summary: cftmerge(1) manual page does not explain what a CTF is
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Mark Johnston
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-11-12 02:10 UTC by Michael Dexter
Modified: 2022-04-28 00:35 UTC (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Michael Dexter 2021-11-12 02:10:01 UTC
Here's an easy doc contributor one:

The ctfmerge(1) and related manual pages to not mention what a CTF is.

CTF is probably the Compact C Type Format, but that should be verified.

https://www.freebsd.org/cgi/man.cgi?query=ctfmerge&apropos=0&sektion=1&manpath=FreeBSD+13.0-RELEASE&arch=default&format=html
Comment 1 Michael Dexter 2021-11-12 17:56:30 UTC
Some background kindly from the wilds that may help with a concise description:

"CTF is designed to represent C types in a more compact format (and simply) than DWARF. It's used extensively in illumos with dtrace, as well as for system debugging. ctfmerge specifically will uniqify the data from all the constitutate .o files (think how many files will have a definition of pid_t, etc)"

https://github.com/illumos/illumos-gate/blob/master/usr/src/uts/common/sys/ctf.h#L38-L56
Comment 2 Yuri 2021-11-12 18:13:21 UTC
There is already ctf(5) man page, so all ctfmerge(1) needs is to mention it in its SEE ALSO section.
Comment 3 Michael Dexter 2021-11-28 05:07:20 UTC
(In reply to Yuri from comment #2)
I suggest that acronyms be spelled out once when used for the benefit of the user.
Comment 4 commit-hook freebsd_committer freebsd_triage 2022-04-21 15:22:11 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=5727eceabc93e218f0dd369a66d06d619e7fa080

commit 5727eceabc93e218f0dd369a66d06d619e7fa080
Author:     Mark Johnston <markj@FreeBSD.org>
AuthorDate: 2022-04-21 14:56:03 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2022-04-21 15:20:28 +0000

    ctf: Link CTF toolchain man pages to ctf.5

    Also expand the CTF acronym to provide a bit of context.

    PR:             259790
    MFC after:      1 week
    Sponsored by:   The FreeBSD Foundation

 cddl/usr.bin/ctfconvert/ctfconvert.1 | 10 ++++++----
 cddl/usr.bin/ctfdump/ctfdump.1       |  9 +++++----
 cddl/usr.bin/ctfmerge/ctfmerge.1     |  9 +++++----
 3 files changed, 16 insertions(+), 12 deletions(-)
Comment 5 commit-hook freebsd_committer freebsd_triage 2022-04-28 00:34:59 UTC
A commit in branch stable/13 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=ccb94ba0dacc14104de4f65b95037b91f71339df

commit ccb94ba0dacc14104de4f65b95037b91f71339df
Author:     Mark Johnston <markj@FreeBSD.org>
AuthorDate: 2022-04-21 14:56:03 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2022-04-28 00:34:30 +0000

    ctf: Link CTF toolchain man pages to ctf.5

    Also expand the CTF acronym to provide a bit of context.

    PR:             259790
    Sponsored by:   The FreeBSD Foundation

    (cherry picked from commit 5727eceabc93e218f0dd369a66d06d619e7fa080)

 cddl/usr.bin/ctfconvert/ctfconvert.1 | 10 ++++++----
 cddl/usr.bin/ctfdump/ctfdump.1       |  9 +++++----
 cddl/usr.bin/ctfmerge/ctfmerge.1     |  9 +++++----
 3 files changed, 16 insertions(+), 12 deletions(-)