uima-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Marshall Schor (JIRA)" <...@uima.apache.org>
Subject [jira] [Resolved] (UIMA-4162) improve 2.7.0 docs
Date Tue, 06 Jan 2015 16:09:35 GMT

     [ https://issues.apache.org/jira/browse/UIMA-4162?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel

Marshall Schor resolved UIMA-4162.
    Resolution: Fixed

> improve 2.7.0 docs
> ------------------
>                 Key: UIMA-4162
>                 URL: https://issues.apache.org/jira/browse/UIMA-4162
>             Project: UIMA
>          Issue Type: Improvement
>            Reporter: Marshall Schor
>            Assignee: Marshall Schor
>            Priority: Minor
>             Fix For: 2.7.0SDK
> In reviewing RC2 of 2.7.0, Burn suggests the following doc changes:
> in References - typo "equlivance"
> 5.6.4 in References says you must addToIndexes after setting the keys, but
> then goes on to show how to use protectIndices without clearly stating that
> this is one of three approaches.
> The block about  -Duima.allow_duplicate_add_to_indices should be moved as
> it is in the middle of the corrupted index section.
> Also we should be consistent in spelling indexes/indices ... I think we're
> stuck with the American spelling now ... I don't see any 'indices' in the
> 2.6 docs.
> 4.5 in References shows how to use protectIndices but perhaps should
> instead link to the larger discussion in 5.6.4
> 10.2 in References describes -Duima.report_fs_update_corrupts_index but
> doesn't give an example of the report message, or what to search for in the
> logs.
> When describing uima.protect_indices_from_key_updates perhaps say that when
> false it acts like pre-2.7.0 and corruption is not detected  (is this
> correct?)  Presumably avoiding the check saves some CPU ... significant?
> In the README Index Corruption section it might help to add a little more
> comparing the three ways to deal with it ... let UIMA fix it, or explicit
> remove/add, or protect block.  Also would help to say what to look for in
> the logs. Or simply refer to the References section.

This message was sent by Atlassian JIRA

View raw message