URL: http://www.math.fu-berlin.de/~guckes/vim/howto/bugrep.html URL: http://www.vim.org/howto/bugrep.html (mirror) Created: Mon Jul 06 00:00:00 CEST 1998 Last update: Fri Jul 16 12:00:00 MET DST 1999
Preparing the report:
Take your time!
Do not just fire up your mailer and send some text in haste.
Remember that some minimal info should always be given with a report.
So please put a little effort into the report.
The more info you give the less questions will have to be asked about it.
It will be well worth it and your work is much appreciated!
Please give info about these things:
NOTE: For vim-5.4 this command must be :so $VIMRUNTIME/bugreport.vim
Options settings:
Version info:
Please always state your version of vim clearly!
You can abbreviate "vim version 5.4a" to "vim-5.4a" and even "vim54a".
Making this one word also has the advantage that you can use the word
completion command on it, ie all you need to type is "vim^P" and
the command ^P (control-p) will expand the word "vim" to "vim46".
Create a version info file:
I suggest that you write this info to a file and keep it around
so you can include with the next bug report.
Settings info:
Please include info about the settings that may affect the error.
If you are not sure which settings have to do with the effect
then please add the info you get from these commands:
":set all", ":set termcap", ":map", ":map!", ":au" (in that order).
If you happen to be sure that not all of these might be appropriate
then just include the ones you think are relevant.
Problem description:
Please give a clear description of problem.
Let us know about the commands you used and
the messages that Vim gave you.
Add examples if possible.
This can certainly take some time - but it can save
a lot of time for those of use who wish to help you.
A elaborated report certainly is much appreciated! :-)
Problem list:
Keep a file around with problems that you have encountered.
This will be useful for testing new releases.
Let us know whether a problem has been fixed!
Let us know about workarounds, too!
Patches:
If you know how to read and change code then PLEASE send a patch, too!
This will save a lot of time for the author and thus will make it a lot easier
for him to fix it.
Sending patches also raises the chances for introducing your new features.
Think about it!
Posting patches:
If you think that your patch will be useful right away for everybody
then you might want to send it to the development list.
please create a "diff file" using GNU's "diff", possibly with "context"
if the patch is small; add the patchfile as an attachment if possible.
Best of all, put your info about workarounds and patches onto a webpage and have it linked to from the Vim User Page. That way, the info will get read by search engines, so the data does not get lost so easily, and we can access it right away without having you send updates. This is especially good if the info is big. Btw, posting the web address to a patch should then suffice.
Subject lines: version command/options
Please make the subject descriptive!
Give the version number and possibly the related command name or option.
Examples for subject lines:
Subject: vim46 - ":help billgates" not found Subject: vim46 - ":goemacs" -> error "no way, buddy" Subject: vim5n - ":syntax on" -> color! Subject: vim5t - ":tnext" Subject: vim5 - goals for vim6 Subject: vim52d - kitchen sink feature does not work Subject: vim54 - more functions, more GUI - but no foldingWhere to send bug reports: author or vim-dev
Bug report prizes -> credit list:
Well, there are no prizes for bug reports. Sorry.
But everyone who contributes much to the code
there is the possibility to get into the credit list
(see ":help credits").
[971229,980611]