Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-13485

Documentation lint failing on broken org.noggit links

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Blocker
    • Resolution: Fixed
    • 8.1.1
    • 8.1.1
    • None
    • None

    Description

      Running ant documentation-lint on a fresh checkout of branch_8_1 produces these errors:

      bare-bones-html-validation:
          [mkdir] Created dir: /Users/ab/work/lucene/lucene-copy2/solr/build/solr-ref-guide/bare-bones-html
      [asciidoctor:convert] Render asciidoc files from /Users/ab/work/lucene/lucene-copy2/solr/build/solr-ref-guide/content to /Users/ab/work/lucene/lucene-copy2/solr/build/solr-ref-guide/bare-bones-html with backend=html5
      [asciidoctor:convert] asciidoctor: ERROR: about-this-guide.adoc: line 1: invalid part, must have at least one section (e.g., chapter, appendix, etc.)
      [asciidoctor:convert] asciidoctor: ERROR: solr-glossary.adoc: line 1: invalid part, must have at least one section (e.g., chapter, appendix, etc.)
           [java] Processed 2536 links (2075 relative) to 3359 anchors in 253 files
           [echo] Validated Links & Anchors via: /Users/ab/work/lucene/lucene-copy2/solr/build/solr-ref-guide/bare-bones-html/
      
      -documentation-lint:
          [jtidy] Checking for broken html (such as invalid tags)...
         [delete] Deleting directory /Users/ab/work/lucene/lucene-copy2/lucene/build/jtidy_tmp
           [echo] Checking for broken links...
           [exec]
           [exec] Crawl/parse...
           [exec]
           [exec] Verify...
           [exec]
           [exec] file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-core/overview-tree.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.Writable.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.Writable.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONParser.html
           [exec]
           [exec] file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-core/org/apache/solr/core/snapshots/CollectionSnapshotMetaData.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.Writable.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.Writable.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.Writable.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.Writable.html
           [exec]
           [exec] file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-core/org/apache/solr/core/snapshots/package-tree.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.Writable.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.Writable.html
           [exec]
           [exec] file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-core/org/apache/solr/core/snapshots/CollectionSnapshotMetaData.CoreSnapshotMetaData.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.Writable.html
           [exec]   BROKEN LINK: file:///Users/ab/work/lucene/lucene-copy2/solr/build/docs/solr-solrj/org/noggit/JSONWriter.Writable.html
      ...
      
           [exec] Broken javadocs links were found! Common root causes:
           [exec] * A typo of some sort for manually created links.
           [exec] * Public methods referencing non-public classes in their signature.
      
      BUILD FAILED
      /Users/ab/work/lucene/lucene-copy2/build.xml:101: The following error occurred while executing this line:
      /Users/ab/work/lucene/lucene-copy2/solr/build.xml:660: The following error occurred while executing this line:
      /Users/ab/work/lucene/lucene-copy2/solr/build.xml:673: The following error occurred while executing this line:
      /Users/ab/work/lucene/lucene-copy2/lucene/common-build.xml:2517: exec returned: 1
      

      Attachments

        Activity

          People

            janhoy Jan Høydahl
            ab Andrzej Bialecki
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: