[2/2] lucene-solr:branch_6x: LUCENE-7858: checkJavadocLinks.py to mention common root causes of broken links

[cp...@apache.org]

LUCENE-7858: checkJavadocLinks.py to mention common root causes of broken links


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/b947dbea
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/b947dbea
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/b947dbea

Branch: refs/heads/branch_6x
Commit: b947dbeae2dd853fe0f3605788c8719785449db1
Parents: 6fe9f2e
Author: Christine Poerschke <cp...@apache.org>
Authored: Fri Jun 2 10:40:53 2017 +0100
Committer: Christine Poerschke <cp...@apache.org>
Committed: Fri Jun 2 11:03:06 2017 +0100

----------------------------------------------------------------------
 dev-tools/scripts/checkJavadocLinks.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/b947dbea/dev-tools/scripts/checkJavadocLinks.py
----------------------------------------------------------------------
diff --git a/dev-tools/scripts/checkJavadocLinks.py b/dev-tools/scripts/checkJavadocLinks.py
index e5ff2f3..2e3cdea 100644
--- a/dev-tools/scripts/checkJavadocLinks.py
+++ b/dev-tools/scripts/checkJavadocLinks.py
@@ -266,7 +266,10 @@ def checkAll(dirName):
 if __name__ == '__main__':
   if checkAll(sys.argv[1]):
     print()
-    print('Broken javadocs links were found!')
+    print('Broken javadocs links were found! Common root causes:')
+    # please feel free to add to this list
+    print('* A typo of some sort for manually created links.')
+    print('* Public methods referencing non-public classes in their signature.')
     sys.exit(1)
   sys.exit(0)