From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-oo1-f49.google.com (mail-oo1-f49.google.com [209.85.161.49]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A98A515B10D; Wed, 11 Sep 2024 17:45:21 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.161.49 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726076723; cv=none; b=qBuPTVNAQ7UE80YVKUSQfyJF4pqrMv8T3nHpF1R3Ips4ObHipr5ISSw08qA76B3P9YUPPCB3C/tjKNaqKn5ZNFTQZ02EE7WXb19ET2YcMsTUhbJAxauEy1cxNLOvpoELa5XHoGzCosSTwrtCKn5mcMAlSW0H2ziQkingKghKx/Y= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726076723; c=relaxed/simple; bh=yrBsxlWEGnaQTlJ5iuOws6MchRPMJlM1WvfH9TUetF0=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=jeWJQrxk6ZVKazIwijNAPgUkOheQ1fbdNs3MpsAjKE0N0cjzGAKKzWG6YMyuBEQsjZMd3CA3+A/TM3yfWRMADWtLEI+5byjkuiALo/v6Sj1b5QdD7PcFihWnlaH0YP/FVy2f/AgWeaaTWo2f4wV2ucNjbnz3ER5F6Ju8MD6dZLM= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=e7nKftXx; arc=none smtp.client-ip=209.85.161.49 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="e7nKftXx" Received: by mail-oo1-f49.google.com with SMTP id 006d021491bc7-5d5c7f24372so70610eaf.0; Wed, 11 Sep 2024 10:45:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1726076720; x=1726681520; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=sEryC26HDDluJUPDb2FLocPjA9qovOLmtn8dxelqX3U=; b=e7nKftXx2mypp27mH7nBfAPKOl3hkHiyhzQIk/Skt3hmiWv4hlmeDI3ru01QWHCxr5 Ze6LOYBWLRpOwXxMDUbJ7alJjIPlSqTnaQ950DLvzx+7xJFpcy5lbNvuZGFR2uigcg+Q j7Qc7Pj6dILHr9UI+7BlQlCL+E7zDBdQUoaMJ9qVg+Lk9AlObnFg1K5C1Ok+fcaHl97H UpSrW2utxFEk/OZ8tWbQSsh9MXrvzE2tFsMBRRdGbuj439+QjyKbXqpziOjOepNCGFZ0 N6ojWJHq/Jq5SC9anEouiIl+bIvFN/du6wstDFp73xWip7IgfO9R6guZwzutwlvWw9SH SJPw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1726076720; x=1726681520; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=sEryC26HDDluJUPDb2FLocPjA9qovOLmtn8dxelqX3U=; b=txLP0WDANtTfHnCPSUErxb2TPzwcwScjOM4COdhk6ds/G3BaCDPyy6fJ9ZAYLx6DEm t2JSA16nwQkzmuKFIDKORpMbD0e8L58pDHxFKLucFWo+7KAuxKQ7GxL/OccELAn9foBm 2aLpCXqfdxLFrZfel5ZbQ4I01IGgCjBjKNFX1VzSKgF/q3Zui65GZWByu8pDaTkt+q6l ok+5TGfnkhsODquKQbbbm16pvGFd/4KbKdRAYbhoGSCwjl6XVs84f6IuqnGYepKml5hI s5M4AOi3Co+yaJr3Z5vObYWlT/E2j7dBc+EcXYDxSHkeEHytdmMYkLbHPZ+07Jam/0nx Mzjw== X-Forwarded-Encrypted: i=1; AJvYcCXjgSd9hExNC981TDWy/vm5UW85BrNTLVkIQcm2ziRp4JqYXJXq+BNbat34M9dW0MknYk6aBu1kTE3WSo0O+A==@vger.kernel.org X-Gm-Message-State: AOJu0Yxi+OWdsW0nOb8LOpPz2QG0pdmB/l7T8XCoQdVS4O3A22ApDfyH UZH89ykwMof2AxcjhXj4Q/VpHF+0qgblIR+he0cNLvPcwK+pVhXcDKgr6SY8rP8= X-Google-Smtp-Source: AGHT+IH2C+23i5HnVfQnyH5byEh9z1KWrcIF+e0BjdxeTkydBp68nFxSfL3QAhFwZ14UHUesT2CaXA== X-Received: by 2002:a05:6870:c10c:b0:277:fbac:1f71 with SMTP id 586e51a60fabf-27c3f0daa7amr50192fac.3.1726076720358; Wed, 11 Sep 2024 10:45:20 -0700 (PDT) Received: from Hridesh-ArchLinux.am.students.amrita.edu ([175.184.253.10]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-719090b0347sm3351588b3a.149.2024.09.11.10.45.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 11 Sep 2024 10:45:20 -0700 (PDT) From: Hridesh MG To: linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org Cc: hridesh , Andy Whitcroft , Joe Perches , Dwaipayan Ray , Lukas Bulwahn , Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Shuah Khan Subject: [PATCH v2 2/2] checkpatch: warn on empty rust doc comments Date: Wed, 11 Sep 2024 23:14:35 +0530 Message-ID: <7877d23adba22e2f89a61efc129ecf1b0627510b.1726072795.git.hridesh699@gmail.com> X-Mailer: git-send-email 2.46.0 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: hridesh Add a check to warn if there are consecutive empty `///` lines in rust files. Suggested-by: Miguel Ojeda Link: https://github.com/Rust-for-Linux/linux/issues/1109 Signed-off-by: Hridesh MG --- No changes in v2, this is a new patch --- scripts/checkpatch.pl | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 39032224d504..c75bc3927bf6 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -3884,6 +3884,13 @@ sub process { } } +# check for consecutive empty /// lines in .rs files + if ($realfile =~ /\.rs$/ && + $rawline =~ /^\+\s*\/\/\/$/ && $prevrawline =~ /^\+\s*\/\/\/$/) { + WARN("RUST_DOC_EMPTY", + "avoid using consecutive empty rustdoc comments\n" . $herecurr); + } + # check for adding lines without a newline. if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { if (WARN("MISSING_EOF_NEWLINE", -- 2.46.0 From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pf1-f182.google.com (mail-pf1-f182.google.com [209.85.210.182]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 63AC6179BF; Sat, 14 Sep 2024 15:24:47 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.182 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726327488; cv=none; b=rekGvS3tL7Gh+WuVGwLtrT54YDiGjJ2WGWkgcsNckSoFtV1R8VzigG1PmSIrGJsWqtk9XJ/Dkb2Ymc9rrAL7gvQdH8H/7Qg3XsAtwzcXN5WtpxzpZKn4LcyX0gW+FCKj09DU8w2Ip7DATjK2iDZCxRUHqF5WV7k7jrfv0WzapGE= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726327488; c=relaxed/simple; bh=/mF78CmISjMAeM9ETh5R6boWVf+mPRmxubAiKOXzW6Y=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=UoUOr7vmJvktXxKg20Bsk1GTYnUUywq72PoPYFogAVLc+RYePvsUBnF39sM1vvT+t+RnTRcsFielWS6Is/HiG04FvhSJqp09lEVYCG9XIXJ1WPam36KpmJTroSQvaL+jHz4cS8qVMXMRrgAeto5gOc7+YNNxhGoSTqdo06JOMGs= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=Jz3Z9hBr; arc=none smtp.client-ip=209.85.210.182 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="Jz3Z9hBr" Received: by mail-pf1-f182.google.com with SMTP id d2e1a72fcca58-7191df6b5f5so2257267b3a.0; Sat, 14 Sep 2024 08:24:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1726327486; x=1726932286; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=t36oXNVlAeqd61XcbUSB6cnA9J3g+hNJhUgNCRHHaUI=; b=Jz3Z9hBrEXk83w9AssPYFyJ2nJ8FF3aVYlDQ1wYzAciosBKzyKl0nF1Q1so+dJ5xeg Yu0dkRNeWnesMyzDHaj00rSgMauXIbXkmRckEES7ZfzjFLbte/yQZ+9WYueRdMfx9K5j mpGN+krb87cjn6ttca0q3MJK2LlgEU0T5rt2GZkQ749KJnlvXdmaQyIZBef245lz+x19 SaeZDWMjtT0bdi25rx8iDuGmFCEZOUfltsYzPscDzXx7NJBjHfXu4flCe2p2AlXDzuMm OiL3OS1m7AqnnX15LgmvSDhK4QqpoZtDuFInX4fr/NsW9suqmbbMlWjqmuN7j8GW+Is9 RtYg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1726327486; x=1726932286; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=t36oXNVlAeqd61XcbUSB6cnA9J3g+hNJhUgNCRHHaUI=; b=vHEgnL+w+QTbJXuZl772tzR4F6I91CBb0xftpdf1OFYfApU/evTeZhZI1wVh0i9iUr v9s6aaZCZyPcpNylPCMhH5M/pYyygFLWaZIyLN0pAzHWer5jRQdOs7iRcX6Uhic+iAYS nE4OKiI758HjEwJjIwrZsPIOSunolx5shubNoVUxYzyHo72f1FrUV0oju6mBa/xz7xr9 A3NliLIRvf7RxQJqlDBNI92WMk6MBBeHEF/xfSayy4tcCJ2+J415CawDoYvuSjdTulZn AEBD0mEJ2aYKqWHL7M5iZ2pOqAJuTcNkxVYhYxnepGr6BBmO2/0jXZMkp5O/R1ou3E0T kk3Q== X-Forwarded-Encrypted: i=1; AJvYcCVgb0/68Ae3X8ZtxTM7c4EgGhdlhOkUNAIbNC7JtIVePaqe5mslZF6HQo38IruQe8fOVS5eIVEKu6L2gEUogw==@vger.kernel.org X-Gm-Message-State: AOJu0YxdIc81RAZcdArv0I8a/687lvAvBIPJSkNVv7GUH6CRgC99/CHa TAuATDDS/g6boaMAM9LxOO42PGtZwu6ABArwQL8UqeOESY7TIQjDCaOM02eSI1U= X-Google-Smtp-Source: AGHT+IFa+Bsp1DEtyaNCbsWORDxwH4y7rTN4lPjYwPHTEugiagfgxbC3b76L0HbmyLi9JKCrcPSD4w== X-Received: by 2002:a05:6a21:3a41:b0:1cf:5b31:313a with SMTP id adf61e73a8af0-1cf75c7e923mr15063676637.1.1726327486187; Sat, 14 Sep 2024 08:24:46 -0700 (PDT) Received: from Hridesh-ArchLinux.domain.name ([117.193.94.149]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-71944b7b301sm1103898b3a.107.2024.09.14.08.24.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 14 Sep 2024 08:24:45 -0700 (PDT) From: Hridesh MG To: linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org Cc: Hridesh MG , Andy Whitcroft , Joe Perches , Dwaipayan Ray , Lukas Bulwahn , Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Shuah Khan Subject: [PATCH v3 2/2] checkpatch: warn on empty rust doc comments Date: Sat, 14 Sep 2024 20:54:29 +0530 Message-ID: <7877d23adba22e2f89a61efc129ecf1b0627510b.1726072795.git.hridesh699@gmail.com> X-Mailer: git-send-email 2.46.0 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Message-ID: <20240914152429._KOAOhf67zIgePxGwfR5ARz1gKdmcq5qq_UQJuzfL18@z> Add a check to warn if there are consecutive empty `///` lines in rust files. Suggested-by: Miguel Ojeda Link: https://github.com/Rust-for-Linux/linux/issues/1109 Signed-off-by: Hridesh MG --- No changes in v2, this is a new patch No changes in v3 --- scripts/checkpatch.pl | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 39032224d504..c75bc3927bf6 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -3884,6 +3884,13 @@ sub process { } } +# check for consecutive empty /// lines in .rs files + if ($realfile =~ /\.rs$/ && + $rawline =~ /^\+\s*\/\/\/$/ && $prevrawline =~ /^\+\s*\/\/\/$/) { + WARN("RUST_DOC_EMPTY", + "avoid using consecutive empty rustdoc comments\n" . $herecurr); + } + # check for adding lines without a newline. if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { if (WARN("MISSING_EOF_NEWLINE", -- 2.46.0