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

inconsistency between documentation and implementation of command line options #3185

Closed
monetdb-team opened this issue Nov 30, 2020 · 0 comments
Closed

Comments

@monetdb-team
Copy link

@monetdb-team monetdb-team commented Nov 30, 2020

Date: 2012-11-16 12:02:44 +0100
From: @drstmane
To: clients devs <>
Version: 11.13.3 (Oct2012)

Last updated: 2013-01-22 09:29:16 +0100

Comment 17943

Date: 2012-11-16 12:02:44 +0100
From: @drstmane

In some (many?/most??/all???) of our command line programs,
mserver5, mclient, msqldump, stethoscope, mnc,
it seems that the actual implementation of command line options differs from their documentation in the respective usage messages and/or man pages,
or getopt_long() is simply used in a wrong way.

See the respective code and its documentation for details.

We need to double check this to make sure that implementation and documentation are aligned with each other and with the actual intention of the respective options.

Moreover, we should align naming and semantics of (similar) command line option across all command line tools.

Comment 17944

Date: 2012-11-16 12:05:07 +0100
From: @drstmane

In fact, mclient & msqldump might be the least likely candidates for inconsistencies. Once they are checked (or fixed, if necessary), please update the component (-> stethoscope) or product (-> MAL/M5, Server tools) accordingly.

Comment 17945

Date: 2012-11-16 12:11:41 +0100
From: @drstmane

There are also inconsistencies / conflicts between supposedly paired long and short options.

Comment 17948

Date: 2012-11-16 12:39:08 +0100
From: @grobian

Yes, and this also differs per platform.

Comment 18043

Date: 2012-11-27 12:34:37 +0100
From: @sjoerdmullender

No need to create a test for this bug.

Comment 18225

Date: 2012-12-02 15:35:18 +0100
From: @drstmane

Finally finalizing my bug-day work yesterday, I hope correctness and consistency of command line options, their documentation and implementation is restored, both in Oct2012 and Feb2013 branch --- for the time being ...

Comment 18379

Date: 2013-01-22 09:29:16 +0100
From: @sjoerdmullender

Oct2012-SP3 has been released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant