From 7dc782e5c557cb0bbcd509cc92c22a3b5bf4c500 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=BD=D0=B0=D0=B1?= <nabijaczleweli@nabijaczleweli.xyz>
Date: Thu, 31 Mar 2022 00:37:28 +0200
Subject: [PATCH] cstyle: remove unused -o
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Remove handling for allowing doxygen- and embedding in splint(?)-style
comments.  This functionality is unused by OpenZFS.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Closes #13264
---
 man/man1/cstyle.1 | 11 -----------
 scripts/cstyle.pl | 40 +++++-----------------------------------
 2 files changed, 5 insertions(+), 46 deletions(-)

diff --git a/man/man1/cstyle.1 b/man/man1/cstyle.1
index f5f9ec78f..d43e72ad6 100644
--- a/man/man1/cstyle.1
+++ b/man/man1/cstyle.1
@@ -30,7 +30,6 @@
 .Sh SYNOPSIS
 .Nm
 .Op Fl chpvCP
-.Op Fl o Ar construct Ns Op , Ns Ar construct Ns …
 .Oo Ar file Oc Ns …
 .Sh DESCRIPTION
 .Nm
@@ -91,16 +90,6 @@ types
 etc.
 This detects any use of the deprecated types.
 Used as part of the putback checks.
-.It Fl o Ar construct Ns Op , Ns Ar construct Ns …
-Available constructs include:
-.Bl -tag -compact -width "doxygen"
-.It Sy doxygen
-Allow doxygen-style block comments
-.Pq Sy /** No and Sy /*!\& .
-.It Sy splint
-Allow splint-style lint comments
-.Pq Sy /*@ Ns ... Ns Sy @*/ .
-.El
 .El
 .
 .Sh CONTINUATION CHECKING
diff --git a/scripts/cstyle.pl b/scripts/cstyle.pl
index d4563cdc9..6d3cebc21 100755
--- a/scripts/cstyle.pl
+++ b/scripts/cstyle.pl
@@ -58,7 +58,7 @@ use Getopt::Std;
 use strict;
 
 my $usage =
-"usage: cstyle [-cghpvCP] [-o constructs] file ...
+"usage: cstyle [-cghpvCP] file...
 	-c	check continuation indentation inside functions
 	-g	print github actions' workflow commands
 	-h	perform heuristic checks that are sometimes wrong
@@ -66,15 +66,11 @@ my $usage =
 	-v	verbose
 	-C	don't check anything in header block comments
 	-P	check for use of non-POSIX types
-	-o constructs
-		allow a comma-separated list of optional constructs:
-		    doxygen	allow doxygen-style block comments (/** /*!)
-		    splint	allow splint-style lint comments (/*@ ... @*/)
 ";
 
 my %opts;
 
-if (!getopts("cgho:pvCP", \%opts)) {
+if (!getopts("cghpvCP", \%opts)) {
 	print $usage;
 	exit 2;
 }
@@ -87,23 +83,6 @@ my $verbose = $opts{'v'};
 my $ignore_hdr_comment = $opts{'C'};
 my $check_posix_types = $opts{'P'};
 
-my $doxygen_comments = 0;
-my $splint_comments = 0;
-
-if (defined($opts{'o'})) {
-	for my $x (split /,/, $opts{'o'}) {
-		if ($x eq "doxygen") {
-			$doxygen_comments = 1;
-		} elsif ($x eq "splint") {
-			$splint_comments = 1;
-		} else {
-			print "cstyle: unrecognized construct \"$x\"\n";
-			print $usage;
-			exit 2;
-		}
-	}
-}
-
 my ($filename, $line, $prev);		# shared globals
 
 my $fmt;
@@ -115,12 +94,7 @@ if ($verbose) {
 	$fmt = "%s: %d: %s\n";
 }
 
-if ($doxygen_comments) {
-	# doxygen comments look like "/*!" or "/**"; allow them.
-	$hdr_comment_start = qr/^\s*\/\*[\!\*]?$/;
-} else {
-	$hdr_comment_start = qr/^\s*\/\*$/;
-}
+$hdr_comment_start = qr/^\s*\/\*$/;
 
 # Note, following must be in single quotes so that \s and \w work right.
 my $typename = '(int|char|short|long|unsigned|float|double' .
@@ -146,8 +120,6 @@ my $lint_re = qr/\/\*(?:
 	PROTOLIB[0-9]*|SCANFLIKE[0-9]*|CSTYLED.*?
     )\*\//x;
 
-my $splint_re = qr/\/\*@.*?@\*\//x;
-
 my $warlock_re = qr/\/\*\s*(?:
 	VARIABLES\ PROTECTED\ BY|
 	MEMBERS\ PROTECTED\ BY|
@@ -536,12 +508,10 @@ line: while (<$filehandle>) {
 		next line;
 	}
 
-	if ((/[^(]\/\*\S/ || /^\/\*\S/) &&
-	    !(/$lint_re/ || ($splint_comments && /$splint_re/))) {
+	if ((/[^(]\/\*\S/ || /^\/\*\S/) && !/$lint_re/) {
 		err("missing blank after open comment");
 	}
-	if (/\S\*\/[^)]|\S\*\/$/ &&
-	    !(/$lint_re/ || ($splint_comments && /$splint_re/))) {
+	if (/\S\*\/[^)]|\S\*\/$/ && !/$lint_re/) {
 		err("missing blank before close comment");
 	}
 	if (/\/\/\S/) {		# C++ comments