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

Fix documentation of interface command-line parameters #5

Open
Penguin-Guru opened this issue Oct 25, 2021 · 1 comment
Open

Fix documentation of interface command-line parameters #5

Penguin-Guru opened this issue Oct 25, 2021 · 1 comment

Comments

@Penguin-Guru
Copy link
Contributor

Penguin-Guru commented Oct 25, 2021

https://github.com/vircadia/vircadia/pull/1428/files

// The documented "--disable-lod" does not seem to exist.
// Below are undocumented.
QCommandLineOption noLauncherOption("no-launcher", "Do not execute the launcher.");
QCommandLineOption overrideScriptsPathOption(SCRIPTS_SWITCH, "set scripts <path>", "path");
QCommandLineOption defaultScriptOverrideOption("defaultScriptsOverride", "override defaultsScripts.js.", "string");
QCommandLineOption responseTokensOption("tokens", "set response tokens <json>.", "json");
QCommandLineOption displayNameOption("displayName", "set user display name <string>.", "string");
// "--traceFile". In my pull request, I change handling for this and add a related parameter "--traceDuration".
// "--clockSkew". I'm not sure if this is still useful for anything.
// "--qmljsdebugger", which appears in output from "--help-all".

Here are additional undocumented parameters I found (not all tested). See my pull request for definitions.
--no-login-suggestion
--traceFile (and in my pull request I add "--traceDuration" to replace some "--traceFile" functionality)
--clockSkew
--testScript
--testResultsLocation
--quitWhenFinished
--fast-heartbeat

Also, "--protocolVersion", which is currently documented, only seems to write to a file (which is a required parameter that must follow it). It does not "display" the output.

@Penguin-Guru Penguin-Guru changed the title Fix documentation of command-line parameters Fix documentation of interface command-line parameters Oct 25, 2021
@Penguin-Guru
Copy link
Contributor Author

Penguin-Guru commented Nov 21, 2021

I think it's very important that the descriptions be clear, distinct, complete, and the same in the (online) documentation and --help output. Since descriptions have not been provided for these parameters in the documentation or on this issue and Dale has already offered some revisions to the tentative descriptions I added in my pull request, I am going to consider those descriptions locked-in. Look there for current --help descriptions.

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

No branches or pull requests

1 participant