Summary: | cftmerge(1) manual page does not explain what a CTF is | ||
---|---|---|---|
Product: | Documentation | Reporter: | Michael Dexter <editor> |
Component: | Manual Pages | Assignee: | Mark Johnston <markj> |
Status: | Closed FIXED | ||
Severity: | Affects Some People | CC: | doc, markj, yuri |
Priority: | --- | ||
Version: | Latest | ||
Hardware: | Any | ||
OS: | Any |
Description
Michael Dexter
2021-11-12 02:10:01 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 There is already ctf(5) man page, so all ctfmerge(1) needs is to mention it in its SEE ALSO section. (In reply to Yuri from comment #2) I suggest that acronyms be spelled out once when used for the benefit of the user. 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(-) 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(-) |