This is the mail archive of the cygwin-apps@cygwin.com mailing list for the Cygwin project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Proposal: Cygwin bug reporting interface


I got inspired by the Debian bug reporting system, so I though writing
one for Cygwin. It would make things more controlled and following the
bug report as well as finding out to whom to report would be easier.

I've made a cygwin package from the current state, which, naturally
may have bugs, but I would encourage all intered people to take a
look and evaluate what could be improved.

The requirement for this bug system:

    - Bash
    - Perl  (not really, the script uses one perl call, I'm working on it)
    - Emacs

    - Emacs must have been configured to send mail.
      Details how to do this are given in INSTALL document.

The way it works is like this:

    $ cygbug <package-name>

To attach files to the bug report:

    $ cygbug -i FILE [-i FILE ...] <package.name>

To list installed package

     cygbug         

I've implemented all the Debian styled Severity reports (wishlist,
minor, normal, grave, serious ...) and the Emacs Lisp modules poke
around the system to provide all needed information. Completing menus
are offered to select packages and mail addresses etc.

The sample bug report mail would look similar to Debian. Here is 
live example after 'cygbug cvs':

    To: Charles Wilson <cwilson <AT> ece.gatech.edu>
    Subject: Cygwin-bug#20040312T00:18 cvs: this is an example
    --text follows this line--
    Package: cvs
    Version: 1.11.6-3
    Status: installed
    Severity: normal


    -- System Information
    Release: 1.5.7 api 0.109 cvs cr-0x9e
    Kernel: Windows 2000 Professional Ver 5.0 Build 2195 Sp4
    Locale: LC_ALL=en_US

    -- Other package insformation
    Info-Pkg-devel-tools: gcc 3.3.1-3, make 3.80-1, libtool 1.5b-1
    Info-Pkg-lang: perl 5.8.2-1, python 2.3.3-1, ruby 1.8.1-1


I have lot more features on the way ....

Jari

a)

wget --non-verbose  \
  http://tierra.dyndns.org:81/cygwin/cygbug/cygbug-20040410-1.tar.bz2 \
  http://tierra.dyndns.org:81/cygwin/cygbug/setup.hint

b) or use this

mkdir cygbug ; cd cygbug
wget -q -O - http://tierra.dyndns.org:81/cygwin/cygbug/get.sh | sh

If you run the postinstall, it will make an alias from 'cygbug' to
'reportbug' (program named after Debian couterpart).

-----------------------------------------------------------------------

/
/usr
/usr/share
/usr/share/doc
/usr/share/doc/cygbug-20040410
/usr/share/doc/cygbug-20040410/INSTALL
/usr/share/doc/cygbug-20040410/MANIFEST
/usr/share/doc/cygbug-20040410/ChangeLog
/usr/share/doc/cygbug-20040410/cygbug.pod
/usr/share/doc/Cygwin
/usr/share/doc/Cygwin/cygbug-20040410.README
/usr/share/emacs
/usr/share/emacs/site-lisp
/usr/share/emacs/site-lisp/tinylibmenu.el
/usr/share/emacs/site-lisp/tinycygwin.el
/usr/share/emacs/site-lisp/tinycygwin-args.el
/usr/share/man
/usr/share/man/man1
/usr/share/man/man1/cygbug.1.gz
/usr/share/man/man1/reportbug.1.gz
/usr/bin
/usr/bin/cygbug
/etc
/etc/postinstall
/etc/postinstall/cygbug.sh

-----------------------------------------------------------------------

cygbug -h

NAME

cygbug - Report bugs to Cygwin pacakges

SYNOPSIS

  cygbug [option] package

OPTIONS

  General

  -h                    Show summary of options
  -L package            List files provided by PACKAGE.
  -p                    List officially installed packages.
                        Using this option terminates program.
  -P                    List all installed packages including 3rd parties.
                        Using this option terminates program.
  -S FILE               Absolute name. Search FILE and try to find
                        correct package.

  Emacs control

  -W                    Start windowed Emacs. This requires that
                        X server is running on display.
  -Q                    No quiet. Load personal settings from ~/.emacs
  -x                    Expert mode. Don't ask too many questions or
                        show help message in Emacs.

DESCRIPTION

There are two ways to report the bug: a) you know the package and
you report bug to it:

    cygbug -i            List installed packages, pick PACKAGE name from here.
    cygbug package       File a bug report.

b) You do not know the package, but you use a command, were the problem
occurs. No worries, there may be slight chance that the package in question
might be found with:

    cygbug -S /usr/bin/awk.exe
    cygbug -S $(which awk)

 The argument to -S option must be absolute path name which is searched
exactly from provided packages.

BUGS

Option -S is experimental and genrally fails because the porting README
files do not always list full install information of files. Then you better
examine listing of -i option and take a guess.

Similarly option -L is experimental and suffers from the same symptoms
as -S.

SEE ALSO

man cygbug





-- 
http://tiny-tools.sourceforge.net/
Swatch @time   http://www.mir.com.my/iTime/itime.htm
               http://www.ryanthiessen.com/swatch/resources.htm
Use Licenses!  http://www.linuxjournal.com/article.php?sid=6225
Which Licence? http://www.linuxjournal.com/article.php?sid=4825
OSI Licences   http://www.opensource.org/licenses/


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]