Bug 36213 - Missing HTML docs (chainsaw, lf5, others), broken link
Summary: Missing HTML docs (chainsaw, lf5, others), broken link
Status: RESOLVED FIXED
Alias: None
Product: Log4j - Now in Jira
Classification: Unclassified
Component: Other (show other bugs)
Version: 1.2
Hardware: Other other
: P2 normal
Target Milestone: ---
Assignee: log4j-dev
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-08-17 00:29 UTC by Ville Skyttä
Modified: 2005-08-21 02:23 UTC (History)
0 users



Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ville Skyttä 2005-08-17 00:29:57 UTC
The 1.2.11 distribution tarball is missing the chainsaw and lf5 HTML docs as 
well as some others which were in the 1.2.9 distribution.  The following were 
in 1.2.9 but are not in 1.2.11:  
  
chainsaw.html  
critique.html  
deepExtension.html  
install-chainsaw.html  
lf5/configuration.html  
lf5/examples.html  
lf5/faq.html  
lf5/features.html  
lf5/overview.html  
lf5/readingfiles.html  
lf5/trouble.html  
praise.html  
  
Additionally, docs/documentation.html links to "faq.html", should be   
"FAQ.html"
Comment 1 Curt Arnold 2005-08-19 01:07:08 UTC
Chainsaw has been spun out of log4j.  I've changed the link to the non-existant local copy of 
chainsaw.html to http://logging.apache.org/log4j/docs/chainsaw.html.

critique.html was an ancient critique of JDK 1.4 logging that was referenced from srtw.html.  Since both 
are seriously obsolete, I removed srtw.html.

deepExtension.html, install-chainsaw.html and praise.html were intentionally removed and do not 
appear to be linked from other documents.  If there is a particular reason they need to be present, 
please reply.

I changed the hyperlink to FAQ.html so it will work properly on case-sensitive file-systems.

Not obvious to me while LF5 documentation would disappear, the source is still present in the CVS and 
the build.xml file does not appear to have changed regarding it.  Though a quick read would suggest it 
shouldn't be there even in 1.2.9.
Comment 2 Curt Arnold 2005-08-19 01:24:49 UTC
Removing the lf5/** exclusion in the "site" target in build.xml will restore the LF5 document, however 
looking at the change log on build.xml, it appears that the exclusion has been in place since 1.2.7.  The 
documentation is not cleared on a build, so it is possible that stale content just stuck around.
Comment 3 Ville Skyttä 2005-08-21 10:13:01 UTC
Note that chainsaw (the software) is still present in the 1_2 branch in CVS, 
but its docs, launcher scripts etc are missing from the branch. 
Comment 4 Ville Skyttä 2005-08-21 10:23:45 UTC
Also, removing the lf5/** exclusion in the "site" target in build.xml won't    
help people who use the distribution tarball, because src/xdocs is not    
included.