Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecation warning for -m option #3398

Merged
merged 1 commit into from
Nov 24, 2024

Conversation

ann0see
Copy link
Member

@ann0see ann0see commented Oct 4, 2024

Adds a deprecation warning if the server is started with -m.

Short description of changes

CHANGELOG: Server: The -m/--htmlstatus option is considered deprecated and has been replaced by JSON RPC's jamulusserver/getClients method. The -m option will be removed in future.

Context: Fixes an issue?

Related to: #3362

Does this change need documentation? What needs to be documented and how?

Yes. Part of #3362

Status of this Pull Request

What is missing until this pull request can be merged?

Approval.

Checklist

  • I've verified that this Pull Request follows the general code principles
  • I tested my code and it does what I want
  • My code follows the style guide
  • I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
  • I've filled all the content above

@ann0see ann0see marked this pull request as ready for review October 4, 2024 19:28
@ann0see ann0see added this to the Release 3.12.0 milestone Oct 4, 2024
src/main.cpp Outdated Show resolved Hide resolved
@ann0see ann0see force-pushed the refactoring/deprecateCLIM branch from 99a0601 to 20684eb Compare October 8, 2024 19:00
@pljones pljones assigned pljones and ann0see and unassigned pljones Oct 8, 2024
@pljones pljones added needs documentation PRs requiring documentation changes or additions JSON-RPC Related to the JSON-RPC API labels Oct 8, 2024
@ann0see ann0see requested a review from gilgongo October 8, 2024 19:21
src/main.cpp Outdated Show resolved Hide resolved
Copy link
Member

@softins softins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to approve, subject to including @pljones suggestion for consistency in capitalisation.

@ann0see ann0see force-pushed the refactoring/deprecateCLIM branch from 20684eb to bb74274 Compare November 24, 2024 20:44
@ann0see ann0see requested a review from softins November 24, 2024 20:45
@ann0see ann0see force-pushed the refactoring/deprecateCLIM branch from bb74274 to 5f17892 Compare November 24, 2024 20:46
To get a client list, JSON RPC should be used instead of `--htmlstatus`/`-m`.
Check out https://github.com/jamulussoftware/jamulus/blob/main/docs/JSON-RPC.md for more information on JSON RPC.

Related to: jamulussoftware#3362

Rephrase deprecation text

Co-authored-by: Peter L Jones <pljones@users.noreply.github.com>
@ann0see ann0see force-pushed the refactoring/deprecateCLIM branch from 5f17892 to df0c877 Compare November 24, 2024 20:48
@ann0see ann0see merged commit 344e3d0 into jamulussoftware:main Nov 24, 2024
11 checks passed
@ann0see ann0see deleted the refactoring/deprecateCLIM branch November 24, 2024 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
JSON-RPC Related to the JSON-RPC API needs documentation PRs requiring documentation changes or additions
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants