Project

General

Profile

Bug #13049

cstyle should tolerate freebsd headers

Added by Patrick Mooney 2 months ago. Updated 2 months ago.

Status:
Closed
Priority:
Normal
Category:
-
Start date:
Due date:
% Done:

100%

Estimated time:
Difficulty:
Medium
Tags:
Gerrit CR:

Description

Currently, the cstyle script does not handle the FreeBSD license headers as they are attached to files from that code base.
For example:

uts/i86pc/io/vmm/vmm.c: 1: improper first line of block comment
uts/i86pc/io/vmm/vmm.c: 1: missing blank after open comment
uts/i86pc/io/vmm/vmm.c: 4: extra space between function name and left paren
uts/i86pc/io/vmm/vmm.c: 21: extra space between function name and left paren
uts/i86pc/io/vmm/vmm.c: 24: extra space between function name and left paren

It would be nice if cstyle could be taught to tolerate such headers so we can remove things like bhyve from the exception lists and bring them into compliance.

The headers in question look like this:

/*-
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2011 NetApp, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 */

Tolerating the /*- comment opening style will allow the rest of the cstyle mechanisms to work properly.


Related issues

Related to illumos gate - Bug #13050: bhyve kernel should be cstyle cleanIn Progress

Actions
Related to illumos gate - Bug #12996: bhyve kernel should be wscheck cleanClosed

Actions

History

#1

Updated by Patrick Mooney 2 months ago

  • Related to Bug #13050: bhyve kernel should be cstyle clean added
#2

Updated by Patrick Mooney 2 months ago

  • Related to Bug #12996: bhyve kernel should be wscheck clean added
#3

Updated by Electric Monk 2 months ago

  • Gerrit CR set to 856
#4

Updated by Patrick Mooney 2 months ago

Prior to this change, running cstyle against files with the standard FreeBSD license header would result in the errors noted in the ticket description (as well as any other out-of-spec issues in the file). With the change, the header issues (lines 1-24) no longer appear as cstyle is able to properly handle that notation. Later issues in the file are still reported.

Changing one of the FreeBSD license headers to a different non-compliant style brings the errors back, showing that the comment detection will only accept the noted variants.

#5

Updated by Garrett D'Amore 2 months ago

I really really hate that our cstyle has some specific idiosyncrasies which makes it pretty much impossible to implement in clang-format, ident, or any of the other automatic code formatters.

While I appreciate the long history this code base has, I'd like to see us consider adopting a set of very modest style changes that could then trivially be implemented in clang-format.

I have a sample .clang-format file that almost achieves that -- I think it's very very close to FreeBSD style (I tried to implement the FreeBSD format actually -- my goal was 100% conformance which was a lot easier than for illumos.)

#6

Updated by Patrick Mooney 2 months ago

  • Description updated (diff)
#7

Updated by Patrick Mooney 2 months ago

  • Description updated (diff)
#8

Updated by Electric Monk 2 months ago

  • Status changed from In Progress to Closed
  • % Done changed from 0 to 100

git commit dcbbe9e03d9d35c714d909a1f4767ce83c885e80

commit  dcbbe9e03d9d35c714d909a1f4767ce83c885e80
Author: Patrick Mooney <pmooney@pfmooney.com>
Date:   2020-08-19T02:32:47.000Z

    13049 cstyle should tolerate freebsd headers
    Reviewed by: Toomas Soome <tsoome@me.com>
    Reviewed by: Andy Fiddaman <andy@omniosce.org>
    Approved by: Robert Mustacchi <rm@fingolfin.org>

Also available in: Atom PDF