Document all accepted command-line options - #377
Open
4Luke4 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
--versionentry alongside the other program-control options-helpalias and explicitly identify the limitations of the experimental--rcmp-*optionsNewly documented options
--automate-file--change-log--change-log-list--change-log-rest--debug-boiic--debug-change--debug-ocaml--exit--help--licence--list-components--list-components-json--list-languages--log-extern--no-exit-pause--print-backtrace--process-script--quick-log--rcmp-from--rcmp-to--search-ids--textcmp-from--textcmp-toImplementation
test/check_command_line_options.plderives the accepted long options from:argDescrinsrc/main.mlMyarg.usageinsrc/myarg.mlIt compares those options with the
\DEFINE{--...}entries indoc/base.texand fails when an option is:This avoids introducing another hard-coded command-line option inventory.
Validation
perl -c test/check_command_line_options.plperl test/check_command_line_options.pl129 command-line options are documented exactly once.make -C dococaml-variants.4.14.2+options,ocaml-option-default-unsafe-stringmakemake linux_zipTERM=xterm ./WeiDU-Linux/weidu --helpgit diff --check origin/devel...origin/docs/issue-28-command-line-optionsThe disposable validation workflow passed both its documentation and supported-Linux build jobs. The workflow existed only for validation and was removed from the final branch.
Existing workflow context
The repository's permanent workflow on the clean commit passed both macOS builds.
Its Linux job stops before compilation because
ocaml/setup-ocamlcan no longer resolve the pinned4.08.1+default-unsafe-stringcompiler; upstreamdevelexhibits the same setup failure.The current Windows job reaches compilation but stops on incompatible-pointer diagnostics in unchanged
src/reg.c. This pull request modifies onlydoc/Makefile,doc/base.tex, and the new parity test.Closes #28