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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

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: 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
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
@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
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: Waiting on Team
Development

Successfully merging this pull request may close these issues.

2 participants