Skip to content
Snippets Groups Projects

Add a TXM memory size preference

    • Closed Issue created by Serge Heiden @sheiden

    [SLH, 31/1/24, , 17/5/24]

    Description

    TXM is sensible to memory size for medium size corpora.
    We must help users tune TXM memory size easily.
    TXM.ini is a too low level way to parameter TXM memory size for the majority of users.

    UI Design

    • TXM memory size management should be in the ‘TXM >Advanced’ preferences entry, in a new ‘Memory’ section after the ‘Messages’ section
    • the ‘Memory size’ parameter UI should be simple (and less flexible than the Java memory parameters)
      • for example tuning both -Xms and -Xmx jvm options from a single public-memory-size-number
        • for example:
        • -Xms = public-memory-size-number / 2
        • -Xmx = public-memory-size-number
    • the ‘Memory size’ parameter value must be expressable with various ways : Java ways may be sufficient (i.e. ‘10g’ or ‘10G’ for 10 GB, ‘10m’ for 10 MB, and ‘10k’ for 10 KB)
    • the ‘Memory size’ parameter value must be controled and refused with an error message until it is correct (otherwise the previous valid memory size should be used) : e.g. it must respect a regex pattern, eg /\[0-9\]+ ?\[gGmMkK\]/
    • applying a new preference value must propose to restart TXM to take effect

    Validation test

    1. go to the "General" preferences page and select show heap status

      image.png

    2. Default heap should be image.png

    3. In the TXM > Advanced preferences page, set Memory size to "3g"

    4. Restart TXM

    5. Check that the tooltip of the heap indicates "max: 3072M"

    Edited

    Designs

      Child items ...

      2. Activity

      Please register or sign in to reply