Page MenuHomeFreeBSD

FIRECRACKER: code comments: typo (compatiblity)
ClosedPublic

Authored by grahamperrin on Feb 23 2023, 6:16 AM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Nov 19, 2:24 PM
Unknown Object (File)
Sun, Nov 3, 1:30 PM
Unknown Object (File)
Sun, Nov 3, 1:30 PM
Unknown Object (File)
Sun, Nov 3, 1:12 PM
Unknown Object (File)
Sep 26 2024, 7:17 AM
Unknown Object (File)
Sep 25 2024, 11:52 PM
Unknown Object (File)
Sep 22 2024, 6:29 PM
Unknown Object (File)
Sep 20 2024, 10:02 AM

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

This revision is now accepted and ready to land.Feb 23 2023, 6:25 AM
zlei added a subscriber: zlei.

Looks good to me.

Since this is 4 different parts of the kernel, please do it as 4 different commits to make MFC easier....

Incidentally, there are a few more occurrences of 'compatiblity' in the src tree …


% rg -i compatiblity /usr/src
/usr/src/crypto/heimdal/doc/doxyout/krb5/html/modules.html
36:<li><a class="el" href="group__krb5__v4compat.html">Heimdal Kerberos 4 compatiblity functions</a>

/usr/src/crypto/heimdal/doc/doxyout/krb5/html/group__krb5__v4compat.html
3:<title>HeimdalKerberos5library: Heimdal Kerberos 4 compatiblity functions</title>
23:<h1>Heimdal Kerberos 4 compatiblity functions</h1><table border="0" cellpadding="0" cellspacing="0">

/usr/src/crypto/heimdal/doc/doxyout/krb5/man/man3/krb5_v4compat.3
1:.TH "Heimdal Kerberos 4 compatiblity functions" 3 "11 Jan 2012" "Version 1.5.2" "HeimdalKerberos5library" \" -*- nroff -*-
5:Heimdal Kerberos 4 compatiblity functions \- 

/usr/src/crypto/heimdal/lib/gssapi/ChangeLog
875:    * spnego/spnego_locl.h: Include <roken.h> for compatiblity.
2386:   version of gssapi for incompatiblity in 3des getmic support
2600:   * compat.c: check for compatiblity with other heimdal's 3des

/usr/src/crypto/heimdal/lib/gssapi/gssapi/gssapi.h
64:/* Compatiblity with MIT Kerberos on the Mac */

/usr/src/crypto/heimdal/lib/krb5/doxygen.c
78:/** @defgroup krb5_v4compat Heimdal Kerberos 4 compatiblity functions */

/usr/src/crypto/heimdal/kuser/kcc.c
73: * Wrapper for command line compatiblity

/usr/src/contrib/llvm-project/llvm/lib/Bitcode/Reader/BitcodeReader.cpp
2781:        // Transparently fix up the type for compatiblity with older bitcode

/usr/src/contrib/mtree/mtree.8
164:flavors attempt to preserve output compatiblity and command line option

/usr/src/contrib/ntp/ntpd/refclock_arc.c
1206:   if(peer->MODE == 0) { /* compatiblity to original version */
1263:   if (peer->MODE == 0) { /* compatiblity to original version */
1387:   if (peer->MODE == 0) { /* compatiblity to original version */

/usr/src/sys/x86/x86/mptable.c
1267:    "MPTable: Unknown compatiblity address space range for bus %u: %d\n",

/usr/src/sys/sys/_endian.h
39:/* BSD Compatiblity */

/usr/src/sys/contrib/ngatm/netnatm/msg/msg.def
46:#    N-ISDN compatiblity not implemented.
69:#    N-ISDN compatiblity not implemented.
94:#    N-ISDN compatiblity not implemented.
142:#   N-ISDN compatiblity not implemented.

/usr/src/sys/amd64/conf/FIRECRACKER
176:# Provide bug-for-bug compatiblity with Linux in MP Table searching

/usr/src/sys/netpfil/ipfw/ip_fw2.c
2005:                                    * Compatiblity: historically bare
%

If I can be of any assistance, I could do the following. I'm trying to guess here that probably it will ease the process for you.

I could split the initial diff onto 4 separate commits and present them as 1 or 4 different PRs on GitHub (I expect that it simplifies your workflow for such trivial changes, let me know if it does not). I hope the following commit messages should be fine:

  • x86: fix compatiblity typo in comments
  • amd64: fix compatiblity typo in comments
  • netpfil: fix compatiblity typo in comments
  • sys: fix compatiblity typo in comments

As I understand, contrib stuff is maintained via vendor branches, hence I omitted the same typo found in sys/contrib (I was focusing on sys only). I guess the best way for contrib is to hit original vendor repositories what later will appear in a vendor branch. I cannot comment on heimdal side, probably it's for the best to postpone it for another day/patch, anyway it's about typo.

Editing /usr/src/.git/COMMIT_EDITMSG, if I un-comment the Author line will that be enough for proper attribution?

sys/amd64/conf/FIRECRACKER: typo (compatiblity)
 
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# Author:    Igor Ostapenko <igor.ostapenko@pm.me>
#
# On branch main …
#
# Changes to be committed:
#       modified:   sys/amd64/conf/FIRECRACKER
#
https://bugs.freebsd.org/269753

PR:                      269753
Reported by:             Igor Ostapenko
Approved by:             doc, src (delphij, imp, zlei)
Differential revision:   https://reviews.freebsd.org/D38741

Editing /usr/src/.git/COMMIT_EDITMSG, if I un-comment the Author line will that be enough for proper attribution?

sys/amd64/conf/FIRECRACKER: typo (compatiblity)
 
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# Author:    Igor Ostapenko <igor.ostapenko@pm.me>
#
# On branch main …
#
# Changes to be committed:
#       modified:   sys/amd64/conf/FIRECRACKER
#
https://bugs.freebsd.org/269753

PR:                      269753
Reported by:             Igor Ostapenko
Approved by:             doc, src (delphij, imp, zlei)
Differential revision:   https://reviews.freebsd.org/D38741

You don't even need to do that. It's a note that the author has already been set.