MantisBT - Doomseeker
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0003290Doomseeker[All Projects] Bugpublic2017-10-04 00:092018-02-19 22:08
ReporterWubTheCaptain 
Assigned ToWubTheCaptain 
PrioritylowSeveritytextReproducibilityhave not tried
StatusclosedResolutionwon't fix 
Platformx86_64 (really cross-platform)OSDebian GNU/LinuxOS Versionbuster/sid
Product Version1.1 
Target VersionFixed in Version 
Summary0003290: Doomseeker's --tests option is undocumented
DescriptionThe --tests command line option of Doomseeker is not documented anywhere, as far as I'm aware.

It appears in src/core/main.cpp, Main::interpretCommandLineParameters().
Steps To Reproduce
$ doomseeker --tests
[00:02:06] Starting Doomseeker. Hello World! :)
...
[00:02:06] Entering test mode.
...
[00:02:06] ==== TESTS SUMMARY: ====
[00:02:06] Tests succeeded:      8
[00:02:06] Tests failed:         6
[00:02:06] Pass percentage:  57.14%
[00:02:06] ==== Done.          ====
Additional InformationNeed-to-know resolution to this ticket for manual pages: 0003247
TagsNo tags attached.
Relationships
related to 0001741closed WubTheCaptain Replace homebrew unit testing engine with CxxTest 
child of 0003247confirmed  Doomseeker's manual page (mdoc/nroff) is missing or incomplete 
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2017-10-04 00:09WubTheCaptainNew Issue
2017-10-04 00:12WubTheCaptainNote Added: 0018424
2017-10-06 17:42ZalewaNote Added: 0018449
2017-10-06 17:43ZalewaRelationship addedrelated to 0001741
2017-10-06 23:41WubTheCaptainStatusnew => acknowledged
2017-10-07 05:31WubTheCaptainRelationship addedrelated to 0003247
2017-10-07 09:10WubTheCaptainNote Added: 0018456
2017-10-07 09:10WubTheCaptainStatusacknowledged => feedback
2017-10-10 13:24WubTheCaptainNote Added: 0018519
2017-10-10 13:24WubTheCaptainStatusfeedback => new
2017-10-11 17:22ZalewaNote Added: 0018531
2017-10-11 18:39WubTheCaptainStatusnew => acknowledged
2017-10-11 18:43WubTheCaptainNote Added: 0018535
2017-10-11 18:43WubTheCaptainStatusacknowledged => closed
2017-10-11 18:43WubTheCaptainAssigned To => WubTheCaptain
2017-10-11 18:43WubTheCaptainResolutionopen => no change required
2018-02-19 22:07WubTheCaptainRelationship replacedparent of 0003247
2018-02-19 22:08WubTheCaptainRelationship replacedchild of 0003247
2018-02-19 22:08WubTheCaptainResolutionno change required => won't fix

Notes
(0018424)
WubTheCaptain   
2017-10-04 00:12   
There is TestCore documentation for the API, at least.

'http://doomseeker.drdteam.org/docs/doomseeker_1.1/classTestCore.php [^]'
(0018449)
Zalewa   
2017-10-06 17:42   
This argument is to be used by developers and not meant to be ever used by the end-user. It basically implements our own unit-testing engine. As you can see, these tests have decayed and half of them is failing (not to mention - 14 tests is a rather puny number).

This is related to 1741.
(0018456)
WubTheCaptain   
2017-10-07 09:10   
I've documented this in man pages (0003247), despite the internal use only and marking it as such.

Is it expected for this feature to go away soon (0001741) or should it also be documented in --help for the time being?
(0018519)
WubTheCaptain   
2017-10-10 13:24   
It's probably also good to ask: Do we intentionally want to leave this undocumented (much like GNU grep's undocumented -X option)?
(0018531)
Zalewa   
2017-10-11 17:22   
I think the main issue with this option is that it's baked into Doomseeker. Unit tests could be compiled into separate executables. The end-user binary doesn't need to be polluted with code that the user should (and most probably will) never execute.

I'd say: don't document it. The end goal here is to have it removed from the main executable altogether.

As a side note, at work I once used tail's undocumented "---disable-inotify" to fix a bug in a larger software.
(0018535)
WubTheCaptain   
2017-10-11 18:43   
No change required, then. I may opt to remove the documentation from 0003247 before publication.