Github user jpeach commented on a diff in the pull request: https://github.com/apache/trafficserver/pull/1233#discussion_r89939168 --- Diff: doc/developer-guide/api/functions/TSMgmtSourceGet.en.rst --- @@ -0,0 +1,69 @@ +.. 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. + +.. include:: ../../../common.defs + +.. default-domain:: c + +TSMgmtSourceGet +*************** + +Synopsis +======== + +`#include <ts/ts.h>` + +.. function:: TSReturnCode TSMgmtSourceGet(const char * var_name, TSMgmtSource * result) + +Description +=========== + +Get the source of a value for a configuration variable. :arg:`var_name` is the name of the variable +as a nul terminated string. The source value is stored in :arg:`result`. The function can return +failure if :arg:`var_name` is not found. + +Types +===== + +.. type:: TSMgmtSource + + Source of the current value for a management (configuration) value. + + .. macro:: TS_MGMT_SOURCE_NULL + + Invalid value, no source available. This is primarily used as an initialization or error value + and should be returned only when an API call fails. + + .. macro:: TS_MGMT_SOURCE_DEFAULT + + The default value provided by the |TS| core. + + .. macro:: TS_MGMT_SOURCE_PLUGIN + + The default value provided by a plugin. This means the configuration variable itself was + created by a plugin and is not part of the |TS| core and the value has not been changed from + that default. + + .. macro:: TS_MGMT_SOURCE_EXPLICIT + + The value has been set in :file:`records.config` or via an explict API call (such as + :c:func:`TSMgmtIntSet`). Note this does not guarantee the value is not the default value, as + the variable could have been set to that value. This only means an administrator or plugin + explicit set the value. + + .. macro:: TS_MGMT_SOURCE_ENV + + The value was retrived from the process environment, overriding the default value. --- End diff -- Needs a `Return` section.
--- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---