[
https://issues.apache.org/jira/browse/GEODE-8818?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17262839#comment-17262839
]
ASF GitHub Bot commented on GEODE-8818:
---------------------------------------
davebarnes97 commented on a change in pull request #5888:
URL: https://github.com/apache/geode/pull/5888#discussion_r555242529
##########
File path:
geode-docs/basic_config/data_entries_custom_classes/copy_on_read.html.md.erb
##########
@@ -0,0 +1,56 @@
+---
+title: Copy on Read Behavior
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+When you get an entry value from the cache, by default, the retrieval methods
return a direct reference to the cached object. This provides the value as
quickly as possible, but also opens the cache to direct, in-place changes.
+
+**Note:**
+Do not directly modify cached values. Modifying a value in place bypasses the
<%=vars.product_name%> distribution framework, including cache writers and
listeners, expiration activities, and transaction management, and can produce
undesired results.
+
+Always change your entries using copies of the retrieved objects—never
directly modify the returned objects. You can do this in one of two ways:
Review comment:
Punctuation nit: please replace the hyphen in "objects-never" with an
em-dash (—), a semicolon, or a full stop.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Make docs of copy-on-read more visible to readers
> -------------------------------------------------
>
> Key: GEODE-8818
> URL: https://issues.apache.org/jira/browse/GEODE-8818
> Project: Geode
> Issue Type: Improvement
> Components: docs
> Reporter: Karen Smoler Miller
> Assignee: Karen Smoler Miller
> Priority: Major
> Labels: pull-request-available
>
> Our users need more visibility of the copy-on-read region attribute. Promote
> the subsection from within Basic Configuration and Programming, Data Entries,
> Managing Data Entries to its own section within Data Entries. Update all
> links within the manual to point to the new section.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
