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

Document basic JSON-RPC api in CLI options #724

Merged
merged 2 commits into from
Mar 16, 2022

Conversation

ann0see
Copy link
Member

@ann0see ann0see commented Mar 15, 2022

Short description of changes
Adds the jsonrpc command line options.

Context: Fixes an issue? Related issues

Related to: #717 (at least a first step)

Status of this Pull Request
Ready for review

What is missing until this pull request can be merged?
Finished.

Does this need translation?
YES.

Checklist

  • I've verified that this Pull Request follows the general code principles
  • I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
  • I'm sure that this Pull Request goes to the correct branch

@ann0see ann0see requested a review from gilgongo March 15, 2022 21:10
@ann0see
Copy link
Member Author

ann0see commented Mar 15, 2022

@dtinth could you please quickly review this?

@ann0see ann0see added this to the Release 3.9.0 milestone Mar 15, 2022
@@ -2,10 +2,13 @@
[comment]: # (This is an include file for use in multiple documents)

- `-h` or `--help` Display help text
- `-i` or `--inifile` Set location of initialization file (overrides default)
- `-i` or `--inifile` Set location of initialization file (overrides default)
Copy link
Contributor

Choose a reason for hiding this comment

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

Spacing?

Copy link
Contributor

Choose a reason for hiding this comment

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

And line 6?

Copy link
Member Author

Choose a reason for hiding this comment

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

Spacing is wrong in the whole file, I think?

Copy link
Contributor

Choose a reason for hiding this comment

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

I guess the spaces get collapsed, anyway. And .md and tables don't always get on...

Copy link
Member Author

Choose a reason for hiding this comment

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

MD tables should work?

- `-Q` or `--qos` Sets the quality of service DSCP value. Default is 128. Disable with 0. QoS is ignored by Windows. To enable it, [see this page](QOS-Windows)
- `-t` or `--notranslation` Disable UI language translations
- `-6` or `--enableipv6` Enable IPv6 addressing (IPv4 is always enabled)
- `-v` or `--version` Output version information and exit
- `-v` or `--version` Output version information and exit
Copy link
Contributor

Choose a reason for hiding this comment

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

Spacing?

Copy link
Member Author

Choose a reason for hiding this comment

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

Please see my new push

@ann0see ann0see force-pushed the feature/documentJSONRPC branch from ce02fd9 to b9aed31 Compare March 15, 2022 22:24
@ann0see ann0see force-pushed the feature/documentJSONRPC branch from b9aed31 to 3bbcede Compare March 15, 2022 22:25
Copy link
Contributor

@pljones pljones left a comment

Choose a reason for hiding this comment

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

At least it's more visually appealing :).

Copy link
Contributor

@dtinth dtinth left a comment

Choose a reason for hiding this comment

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

Yup, looks great!

wiki/en/Include-Shared-Commands.md Outdated Show resolved Hide resolved
Co-authored-by: Thai Pangsakulyanont <dtinth@spacet.me>
@gilgongo
Copy link
Member

gilgongo commented Mar 16, 2022

Don't forget to add this to the man page.

EDIT: I don't know how to I can add it to jamulussoftware/jamulus#2448

@ann0see ann0see merged commit f049a62 into jamulussoftware:next-release Mar 16, 2022
@ann0see ann0see deleted the feature/documentJSONRPC branch March 16, 2022 19:31
@ann0see ann0see restored the feature/documentJSONRPC branch March 16, 2022 22:46
@ann0see ann0see deleted the feature/documentJSONRPC branch July 8, 2022 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants