[
https://issues.apache.org/jira/browse/GEODE-1192?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Anthony Baker closed GEODE-1192.
--------------------------------
> gfsh alter disk-store documentation needs off-line to be added
> --------------------------------------------------------------
>
> Key: GEODE-1192
> URL: https://issues.apache.org/jira/browse/GEODE-1192
> Project: Geode
> Issue Type: Bug
> Components: docs
> Reporter: Darrel Schneider
> Assignee: Dave Barnes
> Fix For: 1.0.0-incubating.M3
>
>
> http://geode.docs.pivotal.io/docs/tools_modules/gfsh/command-pages/alter.html
> needs to have "off-heap" listed for alter disk-store.
> It can have the value true or false and determines if the region will be
> stored in off-heap memory or heap memory.
> Also to make clear that the command can be used to modify or remove a region
> in an offline disk-store I would change:
> Modify configuration options for a specified region or remove a region from
> an offline disk-store.
> to:
> Modify or remove a specified region from an offline disk-store.
> Also the second paragraph does not really make sense:
> You can also use the command to reset specific configuration attributes of
> the disk-store to their default values. For example, you could use alter
> disk-store command to set the region's LRU action to overflow-to-disk.
> What it is really describing are details on how you can modify an existing
> region. I would change it to something like this:
> When modifying a region's configuration you want to change what the
> configuration of the region stored in the disk-store to match the
> configuration you will use when the region is created using APIs or
> cache.xml.
> I would also add this statement:
> If no optional command line options are given instead of altering the region
> the command will just display the current configuration for the region and
> not make any changes.
> In the table of options it describes how --initial-capacity and
> --load-factory are related to ConcurrentHashMap. The descriptions should also
> include --concurrency-level since it is also related to ConcurentHashMap.
> The "default" column for this table needs to some work.
> The only one that has a default is --remove (because by default it is as if
> you said --remove=false). But the normal use case for this option is to just
> say "--remove" with no "=true" tacked on.
> All the other default columns should be blank. So --compressor and
> --enable-statistics is wrong. For this command if you do not specify one of
> these optional arguments then no change will be made to that configuration
> attribute.
> So when we say the default value for --enable-statistics is false it implies
> that not specifying this option is as if you specified
> --enable-statistics=false. But that is not the case; that would mean that if
> you don't have this option that it will change the configuration of
> enable-statistics to false.
> So my recommendation is that you remove this column for this particular
> command and add this to the --compressor description:
> If the parameter is specified without a value, the value of none is used.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
