lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hoss Man (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LUCENE-4437) Add note to README.txt about how to build documentation.
Date Wed, 26 Sep 2012 17:33:07 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-4437?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13463969#comment-13463969
] 

Hoss Man commented on LUCENE-4437:
----------------------------------

FWIW: the way this is dealt with in the Solr README.txt is...

{noformat}
Getting Started
---------------
...
or linked from "docs/index.html" in a binary distribution.
...

Files included in an Apache Solr binary distribution
----------------------------------------------------
...
docs/index.html
  The Apache Solr Javadoc API documentation and Tutorial
...


Instructions for Building Apache Solr from Source
-------------------------------------------------
...
{noformat}

The assumption being that if you are using a source release, you will read hte instructions
on building, and pay attention to where the "built" docs are put when running "ant documentation"

If this issue hashes out a more elegant/simple way of refering to this in the lucene/README.txt,
then we should make corrisponding changes to solr/README.txt


                
> Add note to README.txt about how to build documentation.
> --------------------------------------------------------
>
>                 Key: LUCENE-4437
>                 URL: https://issues.apache.org/jira/browse/LUCENE-4437
>             Project: Lucene - Core
>          Issue Type: Bug
>            Reporter: Robert Muir
>
> README.txt says:
> To review the documentation, read the main documentation page, located at:
> `docs/index.html`
> I think we should add some snippet like (if this is a source distribution, you must run
'ant documentation' first.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message