[Asterisk-code-review] func_odbc.conf.sample: Clarify sample documentation (asterisk[16])

[George Joseph]

George Joseph has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/13967 )

Change subject: func_odbc.conf.sample: Clarify sample documentation
......................................................................

func_odbc.conf.sample: Clarify sample documentation

ASTERISK-20325 #close

Change-Id: I06cb9b467b0fd06c8af2a5aee049f872c09cc4b6
---
M configs/samples/func_odbc.conf.sample
1 file changed, 7 insertions(+), 4 deletions(-)

Approvals:
  Joshua Colp: Looks good to me, but someone else must approve
  George Joseph: Looks good to me, approved; Approved for Submit



diff --git a/configs/samples/func_odbc.conf.sample b/configs/samples/func_odbc.conf.sample
index 706b9ce..c467f7e 100644
--- a/configs/samples/func_odbc.conf.sample
+++ b/configs/samples/func_odbc.conf.sample
@@ -35,14 +35,15 @@
 ;
 ; The following options are available in this configuration file:
 ;
+; dsn          An alias for "writehandle."
 ; readhandle   A comma-separated list of DSNs (from res_odbc.conf) to use when
 ;              executing the readsql statement.  Each DSN is tried, in
 ;              succession, until the statement succeeds.  You may specify up to
 ;              5 DSNs per function class.  If not specified, it will default to
-;              the value of writehandle or dsn, if specified.
+;              the value of "writehandle" or "dsn," if specified.
 ; writehandle  A comma-separated list of DSNs (from res_odbc.conf) to use when
 ;              executing the writesql statement.  The same rules apply as to
-;              readhandle.  "dsn" is a synonym for "writehandle".
+;              readhandle.
 ; readsql      The statement to execute when reading from the function class.
 ; writesql     The statement to execute when writing to the function class.
 ; insertsql    The statement to execute when writing to the function class
@@ -60,6 +61,8 @@
 ;              off is incompatible with the functionality of HASH().
 ; synopsis     Appears in the synopsis field for the command
 ;              'core show function <function name>'
+; syntax       Appears in the syntax field for the command
+;              'core show function <function name>'
 ; mode         This option may be set to 'multirow' to allow the function
 ;              specified to return more than a single row.  However, this
 ;              changes the way that func_odbc normally works.  Instead of the
@@ -88,7 +91,7 @@
 
 ; ODBC_SQL - Allow an SQL statement to be built entirely in the dialplan
 [SQL]
-dsn=mysql1
+writehandle=mysql1
 readsql=${ARG1}
 
 ; ODBC_ANTISOLICIT - A blacklist for known solicitors.
@@ -104,6 +107,6 @@
 
 ; ODBC_PRESENCE - Retrieve and update presence
 [PRESENCE]
-dsn=mysql1
+writehandle=mysql1
 readsql=SELECT location FROM presence WHERE id='${SQL_ESC(${ARG1})}'
 writesql=UPDATE presence SET location='${SQL_ESC(${VAL1})}' WHERE id='${SQL_ESC(${ARG1})}'

-- 
To view, visit https://gerrit.asterisk.org/c/asterisk/+/13967
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 16
Gerrit-Change-Id: I06cb9b467b0fd06c8af2a5aee049f872c09cc4b6
Gerrit-Change-Number: 13967
Gerrit-PatchSet: 2
Gerrit-Owner: Sean Bright <sean.bright at gmail.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Joshua Colp <jcolp at sangoma.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20200317/1c7f0610/attachment-0001.html>