diff --git a/src/documentation/xdocs/faq.xml b/src/documentation/xdocs/faq.xml index 05a172291d..240748a15d 100644 --- a/src/documentation/xdocs/faq.xml +++ b/src/documentation/xdocs/faq.xml @@ -2,6 +2,19 @@ + + + Why is reading a simple sheet taking so long? + + + You've probably enabled logging. Logging is intended only for + autopsie style debugging. Having it enabled will reduce performance + by a factor of at least 100. Logging is helpful for understanding + why POI can't read some file or developing POI itself. Important + errors are thrown as exceptions, which means you probably don't need + logging. + + What is the HSSF "eventmodel"? diff --git a/src/documentation/xdocs/utils/logging.xml b/src/documentation/xdocs/utils/logging.xml index 7e675ee6d3..c687592e12 100644 --- a/src/documentation/xdocs/utils/logging.xml +++ b/src/documentation/xdocs/utils/logging.xml @@ -7,6 +7,7 @@ Overview + @@ -15,7 +16,11 @@

Logging in POI is used only as a debugging mechanism, not a normal runtime - logging system. + logging system. Logging is ONLY for autopsie type debugging, and should + NEVER be enabled on a production system. Enabling logging will reduce + performance by at least a factor of 100. If you are not developing + POI or trying to debug why POI isn't reading a file correctly, then DO + NOT enable logging. You've been warned.