You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by db...@apache.org on 2020/07/22 19:37:16 UTC
[geode] 01/01: GEODE-8377: User Guide: GFSH GC command should be
documented to use only in non-production environments
This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a commit to branch feature/GEODE-8377
in repository https://gitbox.apache.org/repos/asf/geode.git
commit 939ec631bfe59ec0c2483e8032f040acaac236bf
Author: Dave Barnes <db...@apache.org>
AuthorDate: Wed Jul 22 12:31:20 2020 -0700
GEODE-8377: User Guide: GFSH GC command should be documented to use only in non-production environments
---
geode-docs/tools_modules/gfsh/command-pages/gc.html.md.erb | 4 ++++
geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb | 2 +-
2 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/geode-docs/tools_modules/gfsh/command-pages/gc.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/gc.html.md.erb
index cce12d7..0d07a98 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/gc.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/gc.html.md.erb
@@ -23,6 +23,10 @@ Force GC (Garbage Collection) on a member or members.
The default is for garbage collection to occur on all caching members.
+The **gfsh gc** command should be used only in non-production environements, as it is very likely to
+cause cluster members to be kicked out due to being unresponsive, as this is a forced GC event and
+not always handled well by GC outside of normal GC processing.
+
**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command.
**Syntax:**
diff --git a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
index 7fd7bb5..d48a632 100644
--- a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
@@ -209,7 +209,7 @@ limitations under the License.
| [describe member](command-pages/describe.html#topic_D62F3D42B1D84CF68F03D54D5122806A) | Display details of a member with given name/id. | online |
| [export logs](command-pages/export.html#topic_B80978CC659244AE91E2B8CE56EBDFE3) | Export/dump logs to a given directory. | online |
| [export stack-traces](command-pages/export.html#topic_195D27B8B2B64A4E84CF2256636D54BD) | Export the stack trace for a member or members. | online |
-| [gc](command-pages/gc.html) | Force garbage collection on a member or members. | online |
+| [gc](command-pages/gc.html) | Force garbage collection on a member or members. (Development only, not advised for production systems.) | online |
| [list clients](command-pages/list.html#topic_ts1_qb1_dk) | Displays a list of connected clients. | online |
| [list members](command-pages/list.html#topic_5B5BFB2E5F314210858641BE3A689637) | Display all or a subset of members. | online |
| [netstat](command-pages/netstat.html) | Report network information and statistics via the "netstat" operating system command. | online |