Related to #3961
<!-- Kamailio Pull Request Template -->
<!-- IMPORTANT: - for detailed contributing guidelines, read: https://github.com/kamailio/kamailio/blob/master/.github/CONTRIBUTING.md - pull requests must be done to master branch, unless they are backports of fixes from master branch to a stable branch - backports to stable branches must be done with 'git cherry-pick -x ...' - code is contributed under BSD for core and main components (tm, sl, auth, tls) - code is contributed GPLv2 or a compatible license for the other components - GPL code is contributed with OpenSSL licensing exception -->
#### Pre-Submission Checklist <!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply --> <!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above--> <!-- If you're unsure about any of these, don't hesitate to ask on sr-dev mailing list --> - [x] Commit message has the format required by CONTRIBUTING guide - [ ] Commits are split per component (core, individual modules, libs, utils, ...) - [ ] Each component has a single commit (if not, squash them into one commit) - [ ] No commits to README files for modules (changes must be done to docbook files in `doc/` subfolder, the README file is autogenerated)
#### Type Of Change - [ ] Small bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds new functionality) - [ ] Breaking change (fix or feature that would change existing functionality)
#### Checklist: <!-- Go over all points below, and after creating the PR, tick the checkboxes that apply --> - [ ] PR should be backported to stable branches - [ ] Tested changes locally - [ ] Related to issue #XXXX (replace XXXX with an open issue number)
#### Description <!-- Describe your changes in detail -->
You can view, comment on, or merge this pull request online at:
https://github.com/kamailio/kamailio/pull/3975
-- Commit Summary --
* dialog: Remove dlg_flag docs
-- File Changes --
M src/modules/dialog/dlg_handlers.c (2) M src/modules/dialog/doc/dialog_admin.xml (16)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/3975.patch https://github.com/kamailio/kamailio/pull/3975.diff
Hey @btriller,
Good catch regarding the function comment. Thanks!
Regarding the docs, I think it's best that the param `dlg_flag` stay but with maybe a small description ie, `deprecated from version 5.8.4. See dlg_manage()`. This would inform the users to look for the alternative and better option of `dlg_manage()`.
What do you think?
Hey @btriller,
Good catch regarding the function comment. Thanks!
Regarding the docs, I think it's best that the param `dlg_flag` stay but with maybe a small description ie, `deprecated from version 6.x. See dlg_manage()`. This would inform the users to look for the alternative and better option of `dlg_manage()`.
What do you think?
I only realized that not removing module parameter in docs was intended after opening this PR. Feel free to close this PR. Still, IMHO it'd be better to remove this in devel docs and add removal to 6.0 upgrade docs.
Closed #3975.
Hey @btriller,
Changes in code were pushed in commit 66fe6eb71e58a02222d1a2fb00f9a0cdb863134c.
I thought it was best to have `dlg_flag` deprecated docs though, so I didn't remove those!