You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by cp...@apache.org on 2017/06/02 10:01:26 UTC
[3/3] lucene-solr:master: LUCENE-7858: checkJavadocLinks.py to
mention common root causes of broken links
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/445ceda0
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/445ceda0
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/445ceda0
Branch: refs/heads/master
Commit: 445ceda01cb5355d4a21a095a19fe1af2b28959e
Parents: cccf97c
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 10:40:53 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/445ceda0/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)