[asterisk-bugs] [JIRA] (ASTERISK-27737) 'identify_by' pjsip.conf option documentation is wrong

[Asterisk Team (JIRA)]

    [ https://issues.asterisk.org/jira/browse/ASTERISK-27737?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=242544#comment-242544 ] 

Asterisk Team commented on ASTERISK-27737:
------------------------------------------

Thanks for creating a report! The issue has entered the triage process. That means the issue will wait in this status until a Bug Marshal has an opportunity to review the issue. Once the issue has been reviewed you will receive comments regarding the next steps towards resolution.

A good first step is for you to review the [Asterisk Issue Guidelines|https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines] if you haven't already. The guidelines detail what is expected from an Asterisk issue report.

Then, if you are submitting a patch, please review the [Patch Contribution Process|https://wiki.asterisk.org/wiki/display/AST/Patch+Contribution+Process].

> 'identify_by' pjsip.conf option documentation is wrong
> ------------------------------------------------------
>
>                 Key: ASTERISK-27737
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-27737
>             Project: Asterisk
>          Issue Type: Bug
>      Security Level: None
>          Components: Documentation
>    Affects Versions: 15.2.2
>            Reporter: Jacek Konieczny
>              Labels: pjsip
>
> The table at the top of https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip shows the default value to be '{{username,location}}'.
> Then, in the [option description|https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip#Asterisk15Configuration_res_pjsip-endpoint_identify_by], {{username}} and {{auth_username}} are listed as valid values.
> Identification by the {{identify}} section is mentioned in a way that suggests that only {{identify}} section would be used when {{identify_by}} is not set.
> The actual behaviour is quite different:
> * The accepted values are: {{username}}, {{auth_username}} and {{ip}}
> * The default value is: {{username,ip}}
> * …which is used when {{identify_by}} is not set in the config file, so existing {{identify}} section is used *in addition* to the user name.
> That mismatch between documentation and actual behaviour may be quite confusing.



--
This message was sent by Atlassian JIRA
(v6.2#6252)