[PATCH master] checkpatch: fix detection of barebox root directory

[PATCH master] checkpatch: fix detection of barebox root directory

[Ahmad Fatoum]

In v2024.09.0, we switched from our old README to a new fancy
README.rst. What was missing though, was adjusting scripts/checkpach.pl
as it uses the existence of a number of files, including the README file
to decide whether a directory is the top-level barebox directory or not.

Rename README to README.rst and while at it, change the error messages
to not output a confusing:

  checkpatch.pl: Must be run from the top-level dir. of a kernel tree

Reported-by: danct12 # IRC
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 scripts/checkpatch.pl | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index ce1c9b48476c..9093841d8179 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -96,7 +96,7 @@ Options:
   --show-types               show the specific message type in the output
   --max-line-length=n        set the maximum line length, if exceeded, warn
   --min-conf-desc-length=n   set the min description length, if shorter, warn
-  --root=PATH                PATH to the kernel tree root
+  --root=PATH                PATH to the barebox tree root
   --no-summary               suppress the per-file summary
   --mailback                 only produce a report in case of warnings/errors
   --summary-file             include the filename in summary
@@ -329,7 +329,7 @@ if ($tree) {
 	}
 
 	if (!defined $root) {
-		print "Must be run from the top-level dir. of a kernel tree\n";
+		print "Must be run from the top-level dir. of a barebox tree\n";
 		exit(2);
 	}
 }
@@ -1097,7 +1097,7 @@ sub top_of_kernel_tree {
 	my @tree_check = (
 		"arch", "commands", "common", "COPYING", "defaultenv",
 		"Documentation", "drivers", "fs", "include", "lib",
-		"MAKEALL", "Makefile", "net", "README", "scripts"
+		"MAKEALL", "Makefile", "net", "README.rst", "scripts"
 	);
 
 	foreach my $check (@tree_check) {
-- 
2.39.5

Re: [PATCH master] checkpatch: fix detection of barebox root directory

[Sascha Hauer]

On Mon, 02 Dec 2024 13:42:32 +0100, Ahmad Fatoum wrote:
> In v2024.09.0, we switched from our old README to a new fancy
> README.rst. What was missing though, was adjusting scripts/checkpach.pl
> as it uses the existence of a number of files, including the README file
> to decide whether a directory is the top-level barebox directory or not.
> 
> Rename README to README.rst and while at it, change the error messages
> to not output a confusing:
> 
> [...]

Applied, thanks!

[1/1] checkpatch: fix detection of barebox root directory
      https://git.pengutronix.de/cgit/barebox/commit/?id=1d6b85a11f75 (link may not be stable)

Best regards,
-- 
Sascha Hauer <s.hauer@pengutronix.de>