Skip to content

improve jtidy javadocs check [LUCENE-4505] #5571

@asfimport

Description

@asfimport

Currently we are using the ant task (http://sourceforge.net/p/jtidy/code/1261/tree/trunk/jtidy/src/main/java/org/w3c/tidy/ant/JTidyTask.java) built into jtidy itself.

This has a number of disadvantages:

  • at least in the version we are using, creates a ByteArrayDataOutput that hides all the output. So if there is an error, its no good.
  • requires creation of a temp directory: even though we disable the actual output with a parameter, this means it creates thousands of 0 byte files

We only pass 3 options to tidy today:

  • input-encoding=UTF-8
  • only-errors=true
  • show-warnings=false <-- this one is a OOM hack.

Ideally i think we would:

  • pass input-encoding=UTF-8, only-errors=true, quiet=true.
  • send all output to a single file or property.
  • if this contains any contents, fail and print the contents.

This would mean we would fail on warnings too (I checked, this is a good thing, there would be some things to fix).
So as a start we could just set show-warnings=false temporarily so we only fail on errors like today.


Migrated from LUCENE-4505 by Robert Muir (@rmuir)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions