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.

Sign up for GitHub

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

Jump to bottom

[Help document bug] For imginfo, the help document misses some options #343

Closed
ccccmd opened this issue Sep 30, 2022 · 1 comment
Closed

[Help document bug] For imginfo, the help document misses some options #343

ccccmd opened this issue Sep 30, 2022 · 1 comment

Comments

@ccccmd
Copy link

ccccmd commented Sep 30, 2022

The "--help" option of imginfo misses the option "X", "default-memory-limit", "list-enabled-formats“，"list-all-formats", "enable-format" and "enable-all-formats" for version 3.0.6.

  • For the option "X", the following code appears during option parsing and modifies the special in src/app/imginfo.c:207-208 for version 3.0.6.
			special = 1;
			break;
  • For the option "default-memory-limit", the following code appears during option parsing and modifies the default_mem_limit in src/app/imginfo.c:210-211 for version 3.0.6.
			default_mem_limit = true;
			break;
  • For the option "list-enabled-formats", the following code appears during option parsing and modifies the list_codecs and list_codecs_all in src/app/imginfo.c:217-219 for version 3.0.6.
			list_codecs = 1;
			list_codecs_all = 0;
			break;
  • For the option "list-all-formats", the following code appears during option parsing and modifies the list_codecs and list_codecs_all in src/app/imginfo.c:213-215 for version 3.0.6.
			list_codecs = 1;
			list_codecs_all = 1;
			break;
  • For the option "enable-format", the following code appears during option parsing and modifies the enable_format in src/app/imginfo.c:221-222 for version 3.0.6.
			enable_format = jas_optarg;
			break;
  • For the option "enable-all-formats", the following code appears during option parsing and modifies the enable_all_formats in src/app/imginfo.c:224-225 for version 3.0.6.
			enable_all_formats = 1;
			break;

But they do not appear in the document provided by "--help".

It may prevent users from using the relevant function.
@ccccmd ccccmd changed the title For imginfo, the help document misses some options [Help document bug] For imginfo, the help document misses some options Sep 30, 2022
mdadams added a commit that referenced this issue Nov 4, 2022
@mdadams
Fixes #342, #343, #344.
e97639f 
Some command-line options for the jasper, imginfo, imgcmp, and jiv
programs (that are not deemed to be for internal use only) were not
documented in the manual.  Descriptions for these options have now been
added to the manual.

The help information message printed by each of the jasper, imginfo,
imgcmp, and jiv programs has been improved.  A mention of the URL for the
online documentation is now included in all help messages.  A comment
has also been added indicating that not all options are listed in the
help message and that the manual should be checked for a complete list
of options (excluding, of course, the ones that are deemed to be for
internal use only and are deliberately undocumented).
@mdadams mdadams mentioned this issue Nov 4, 2022
Closed
@mdadams
Copy link
Collaborator

mdadams commented Nov 4, 2022

See the comment for #344. This issue has been fixed on the master branch. See commit e97639f.

@mdadams mdadams closed this as completed Nov 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mdadams @ccccmd