Page MenuHomeFreeBSD

Change sysdecode_syscallnames to sysdecode_syscallname in man pages
ClosedPublic

Authored by felix.the.red_gmail.com on Jun 24 2025, 4:36 AM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Oct 24, 9:58 AM
Unknown Object (File)
Fri, Oct 10, 5:33 PM
Unknown Object (File)
Fri, Oct 10, 5:33 PM
Unknown Object (File)
Fri, Oct 10, 5:33 PM
Unknown Object (File)
Fri, Oct 10, 5:33 PM
Unknown Object (File)
Fri, Oct 10, 12:24 PM
Unknown Object (File)
Thu, Oct 9, 5:45 PM
Unknown Object (File)
Fri, Oct 3, 1:49 PM

Details

Summary

lib/libsysdecode/Makefile: Change reference to sysdecode_syscallname.3
lib/libsysdecode/sysdecode.3: Move LIBRARY section to synopsis to match modern style.
Rename references to sysdecode_syscallnames to sysdecode_syscallname.
lib/libsysdecode/sysdecode_abi_to_freebsd_errno.3: Rename references to sysdecode_syscallnames to sysdecode_syscallname.
lib/libsysdecode/sysdecode_syscallnames.3: rename to lib/libsysdecode/sysdecode_syscallname.3
Rename references to sysdecode_syscallnames to sysdecode_syscallname.

From the original PR:
The manual pages for sysdecode make reference to a function called "sysdecode_syscallnames".
This function is actually called "sysdecode_syscallname" (singular instead of plural).

PR:278383

Test Plan

grep -Rn sysdecode_syscallnames

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

fernape requested changes to this revision.Jun 26 2025, 4:23 PM
fernape added a subscriber: fernape.

I'm not sure if I'm missing something. Isn't the current name the good one?

lib/libsysdecode/sysdecode_syscallnames.3

This revision now requires changes to proceed.Jun 26 2025, 4:23 PM

The header lib/libsysdecode/sysdecode.h has the function declaration
const char *sysdecode_syscallname(enum sysdecode_abi _abi, unsigned int _code);

Note the function is singular (no 's' at the end).

This revision changes the manual page to match the header declaration.

ziaee requested changes to this revision.EditedJun 26 2025, 7:04 PM

Git grep shows that you are correct. However, you missed a spot, sysdecode_abi_to_freebsd_errno(3) also cross-references this page, and needs to be updated.

As I have been trying to tell you, we need to provide better summaries. A bug report is not a test plan, we have no idea if that bug was wrong in the first place, or was overcome by events. A good test plan for this change would read:

# compare the output of the following:
cd src
git grep sysdecode_syscallname
git grep sysdecode_syscallnames

There would be no confusion then.

You are sending a lot of patches and doing a lot of good, important, and appreciated work. Please read the docs on writing commit messages (summary field).

https://docs.freebsd.org/en/articles/committers-guide/#commit-log-message

Please use src/tools/tools/git/git-arc.sh or use -9999 for your diffs so we have more context.

Edit: note that we do need the PR number, but it goes at the bottom of the summary, inside the summary (the log message you type after you git commit)

The header lib/libsysdecode/sysdecode.h has the function declaration
const char *sysdecode_syscallname(enum sysdecode_abi _abi, unsigned int _code);

Note the function is singular (no 's' at the end).

This revision changes the manual page to match the header declaration.

This is what you need to put in the summary. And the PR number. And it would be very helpful if you could use git log and git branch --contains and determine if this behavior is present in existing releases, and then add a MFC tag. All this is in the doc I linked above.

the summary (the log message you type after you git commit)

You're making assumptions about how I work.
I do not commit using git.
I use Phabricator.
I will work to improve the summaries.

Fixed more instances of sysdecode_syscallnames

This revision was not accepted when it landed; it landed in state Needs Review.Aug 26 2025, 12:50 AM
This revision was automatically updated to reflect the committed changes.

I removed the LIBRARY change upon commit because when moving things, it's very important that commit is only doing that one logical thing completely. Thank you Felix.

We forgot to add sysdecode_syscallnames.3 to Obsoletefiles.inc, so that it gets removed with make delete old. I fixed it in main. Thanks to @mhorne for reporting this.