From cb012a5b625a7707c429f1e95db59018a6dcb992 Mon Sep 17 00:00:00 2001
From: Jonathan Gibbons <jjg@openjdk.org>
Date: Fri, 25 Mar 2022 21:20:02 +0000
Subject: [PATCH] 8283648: Improve the snippet "file not found" message.

Reviewed-by: prappo
---
 .../doclets/toolkit/resources/doclets.properties       |  3 ++-
 .../doclets/toolkit/taglets/SnippetTaglet.java         |  4 ++--
 .../javadoc/doclet/testSnippetTag/TestSnippetTag.java  | 10 +++++-----
 3 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
index c67865344ee..55ce24edd87 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2010, 2021, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2010, 2022, Oracle and/or its affiliates. All rights reserved.
 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 #
 # This code is free software; you can redistribute it and/or modify it
@@ -52,6 +52,7 @@ Please file a bug against the javadoc tool via the Java bug reporting page\n\
 (http://bugreport.java.com) after checking the Bug Database (http://bugs.java.com)\n\
 for duplicates. Include error messages and the following diagnostic in your report. Thank you.
 doclet.File_not_found=File not found: {0}
+doclet.snippet_file_not_found=file not found on source path or snippet path: {0}
 doclet.Copy_Overwrite_warning=File {0} not copied to {1} due to existing file with same name...
 doclet.Copy_Ignored_warning=File {0} not copied: invalid name
 doclet.Copy_snippet_to_clipboard=Copy
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SnippetTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SnippetTaglet.java
index 3c13b194c22..a10f369c1b1 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SnippetTaglet.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SnippetTaglet.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -240,7 +240,7 @@ public class SnippetTaglet extends BaseTaglet {
 
             if (fileObject == null) {
                 // i.e. the file does not exist
-                throw new BadSnippetException(a, "doclet.File_not_found", v);
+                throw new BadSnippetException(a, "doclet.snippet_file_not_found", v);
             }
 
             try {
diff --git a/test/langtools/jdk/javadoc/doclet/testSnippetTag/TestSnippetTag.java b/test/langtools/jdk/javadoc/doclet/testSnippetTag/TestSnippetTag.java
index 4b0dd06a2a2..9923a191a57 100644
--- a/test/langtools/jdk/javadoc/doclet/testSnippetTag/TestSnippetTag.java
+++ b/test/langtools/jdk/javadoc/doclet/testSnippetTag/TestSnippetTag.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -1079,11 +1079,11 @@ public class TestSnippetTag extends SnippetTester {
         checkExit(Exit.ERROR);
         checkOutput(Output.OUT, true,
                     """
-                    A.java:4: error: File not found: %s""".formatted(fileName));
+                    A.java:4: error: file not found on source path or snippet path: %s""".formatted(fileName));
         checkOutput("pkg/A.html", true, """
                         <details class="invalid-tag">
                         <summary>invalid @snippet</summary>
-                        <pre>File not found: text.txt</pre>
+                        <pre>file not found on source path or snippet path: text.txt</pre>
                         </details>
                         """);
         checkNoCrashes();
@@ -1140,7 +1140,7 @@ public class TestSnippetTag extends SnippetTester {
         checkExit(Exit.ERROR);
         checkOutput(Output.OUT, true,
                     """
-                    A.java:4: error: File not found: %s""".formatted(fileName));
+                    A.java:4: error: file not found on source path or snippet path: %s""".formatted(fileName));
         checkNoCrashes();
     }
 
@@ -1869,7 +1869,7 @@ public class TestSnippetTag extends SnippetTester {
         checkExit(Exit.ERROR);
         checkOutput(Output.OUT, true,
                     """
-                    A.java:4: error: File not found: %s""".formatted(fileName));
+                    A.java:4: error: file not found on source path or snippet path: %s""".formatted(fileName));
         checkNoCrashes();
     }