\Feedback and SupportMinimal Examples and Why They Are Important
|Minimal Examples and Why They Are Important|
If you wish to contact anyone (probably me) about a
question you have
or to report a possible MAKEMSI bug
(or in some cases even to make a suggestion) then
in almost all but the most trivial cases it pays to create a
"minimal" and "standalone" testcase.
Please supply all files zipped up in an archive
to ensure they arrive intact without any conversions by your or my email clients
or web middleware components etc.
For example, I don't have to unwrap lines or worry about possible code page
changes altering characters (which have happened in the past).
An example of the freeware 7ZIP with an opened archive:
|What is a Minimal Testcase?|
The attributes of a minimal and stand-alone example are:
- Me or anyone else can unzip the
attachment into a empty
subdirectory and immediately build it as it contains all required
files including any required source files that the MAKEMSI script might
Test this for yourself, unzip the file you are about to send into
a new location and ensure it is complete.
Ideally this would be on a new machine or it may find files you
Double check it reproduces the issue, there have been many times
that I have wasted my time on a perfectly working piece of code
because the person sending it assumed it would display the problem!!!!
- It doesn't contain any more than what is required, this means that you
have probably spend significant (non-trivial) time reducing the
problem down to its basics and have probably therefore eliminated
something you have done to cause the issue.
I get many MAKEMSI problem reports where this turns out not to be the case.
While I'm happy to help, I don't get paid to help you solve your
A minimal testcase is much easier for all of us to diagnose
and fix any problem.
- Any excess lines and commands that are not required to reproduce
the issue should be removed.
- If you can demonstrate a bug in the "TREE" handling of the
"file" command with two small files in
2 subdirectories don't send me 100 files in 50 subdirectories
which total 1GIG!
- You have removed any files you "#include" or have again
reduced their contents to near nothing.
This can take a while to do, in the meantime you could give me a "heads up"
indicating that you are working on a minimal example, I may have an answer
or I may be able to do some preliminary checking.
- It documents any special steps that are required and clearly states
what you think is the problem, for example by what did or didn't happen.
Many times people have simply misunderstood what something does, or
they have assumed I'm psychic.
- If you need to show me a "good" and "bad" (or simply slightly different)
variations then please don't make me uncomment lines or change commands,
supply me all versions, and tell me what to do.
You probably want to include the generated msi (if not too big) and
log files such as the "*.dbg.txt" file
(in which case consider turning "DBG_ALL" to "Y").