[jira] [Created] (HAWQ-946) Document which GUCs are not intended for end-user customization

["Severine Tymon (JIRA)" <ji...@apache.org>]

Severine Tymon created HAWQ-946:
-----------------------------------

             Summary: Document which GUCs are not intended for end-user customization
                 Key: HAWQ-946
                 URL: https://issues.apache.org/jira/browse/HAWQ-946
             Project: Apache HAWQ
          Issue Type: Improvement
          Components: Documentation
            Reporter: Severine Tymon
            Assignee: Lei Chang


There are a number of GUCs (server configuration parameters) that are *not* described currently in the product documentation but are visible either via 1) `hawq config` 2) or within code (src/backend/utils/misc/guc.c). These parameters should be labeled (or documented) appropriately. Make clear which configs are intended for developer debugging purposes only and are not intended for HAWQ end-user customization. 

Requesting that we:
1) Document the usage of the GUC and/or label the GUC context correctly in code as "internal-only" or "developer option" (in other words, apply appropriate contexts consistently.) Also, possibly hide these configs from hawq config output.
2) Add documentation for GUCs in which end user customization is possible but not recommended except for specific, advanced use cases.
3) If the GUC is no longer in use, then deprecate the GUC (either remove or mark as DEFUNCT?) . For example, "gp_vmem_idle_resource_timeout" was removed from product docs, but not from code.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)