KSYMVERS(1)

πŸ“¦ version 1.1.0+git0.3857c3a, in opensuse-leap 16.0

πŸ’– NAME πŸ’–

okay so welcome to the KSYMVERS(1) manual page, bestie β€” it's from the General Commands Manual, and the name is doing exactly what it says on the tin:

ksymvers β€” a tool to work with Linux-kernel symvers files


✨ SYNOPSIS ✨

ksymvers [GENERAL-OPTION]... { compare } [COMMAND-OPTION]... ...

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so ksymvers is a tool that provides functionality to work with symvers files. These files summarize the exported symbols of the kernel and its modules. The data is produced by the modpost utility from the kernel tree. No cap β€” that's the whole point.

The tool primarily operates with a final symvers file, typically called Module.symvers, as it is produced during a single build of the Linux kernel.

The provided functionality is divided into integrated commands. The only currently available command is compare, which shows the differences between two symvers files.

πŸŽ€ GENERAL OPTIONS πŸŽ€

  • -d, --debug β€” Enable debug output. (Yes, debug tea is served.)
  • -h, --help β€” Display global help information and exit.
  • --version β€” Output version information and exit.

πŸ‘‘ COMPARE COMMAND πŸ‘‘

ksymvers compare [COMPARE-OPTION]... FILE FILE2

The compare command shows the differences between two symvers files. In a typical use case, the first input will point to a reference symvers file and the second input will point to a symvers file from a new build of the Linux kernel. Reference first, new build second β€” that's the assignment.

Available options πŸ’…

  • -h, --help β€” Display help information for the command and exit.
  • --filter-symbol-list=FILE β€” Consider only symbols that match the patterns in FILE. Filtering is self-care.
  • -r FILE, --rules=FILE β€” Load kABI severity rules from FILE.
  • -f TYPE[:FILE], --format=TYPE[:FILE] β€” Change the output format to TYPE, or write the TYPE-formatted output to FILE.

The TYPE can be one of the following:

  • null – produces no output,
  • pretty – produces human-readable output in detailed form,
  • short – produces human-readable output in compact form,
  • symbols – shows only the names of exported symbols that have been added, removed, or modified,
  • mod-symbols – shows only the names of exported symbols that have been modified; any additions or removals are omitted.

πŸ’€ EXIT STATUS πŸ’€

okay so the exit status is 0 on success and 2 if an error occurs. The compare command returns 0 if there are no differences and 1 if there are any (non-tolerated) changes. That's the whole vibe β€” no differences, no drama.

🌈 SEE ALSO 🌈


that's the whole page, bestie 🫢 β€” KSYMVERS(1), from the General Commands Manual. The footer as given doesn't show a separate version number or date, so I'm not inventing one; no cap, just the manual name. πŸ’…βœ¨

πŸ“¦ where this page comes from