Script to help users to report a BUG

Script to help users to report a BUG

[Paolo Ciarrocchi]

[-- Attachment #1: Type: text/plain, Size: 674 bytes --]

Hi all,
what do you think about this simple idea of a script that could help
users to fill better BUG reports ?

The usage is quite simple, put the attached file in
/usr/src/linux/scripts and then:

[root@frodo scripts]# ./report-bug.sh /tmp/BUGREPORT/
cat: /proc/scsi/scsi: No such file or directory

[root@frodo scripts]# ls /tmp/BUGREPORT/
cpuinfo.bug  ioports.bug  modules.bug  software.bug
iomem.bug    lspci.bug    scsi.bug     version.bug

Now you can simply attach all the .bug files to the bugzilla report or
inline them in a email.

The script is rude but it is enough to give you an idea of what I have in mind.

Any comment ?


-- 
Paolo

[-- Attachment #2: report-bug.sh --]
[-- Type: application/x-sh, Size: 510 bytes --]

Re: Script to help users to report a BUG

[randy_dunlap]

On Sun, 19 Jun 2005 22:32:16 +0200 Paolo Ciarrocchi wrote:

| Hi all,
| what do you think about this simple idea of a script that could help
| users to fill better BUG reports ?
| 
| The usage is quite simple, put the attached file in
| /usr/src/linux/scripts and then:
| 
| [root@frodo scripts]# ./report-bug.sh /tmp/BUGREPORT/
| cat: /proc/scsi/scsi: No such file or directory
| 
| [root@frodo scripts]# ls /tmp/BUGREPORT/
| cpuinfo.bug  ioports.bug  modules.bug  software.bug
| iomem.bug    lspci.bug    scsi.bug     version.bug
| 
| Now you can simply attach all the .bug files to the bugzilla report or
| inline them in a email.
| 
| The script is rude but it is enough to give you an idea of what I have in mind.
| 
| Any comment ?

It can be useful.  We certainly see bug reports with a good bit
of missing information.

I would rather see the script write all /proc etc. contents to just
one file (with some headings prior to each file).  One file would be
easier to email inline or to attach...

---
~Randy

Re: Script to help users to report a BUG

[Michał Piotrowski]

Hi,

randy_dunlap napisał(a):

>On Sun, 19 Jun 2005 22:32:16 +0200 Paolo Ciarrocchi wrote:
>
>| Hi all,
>| what do you think about this simple idea of a script that could help
>| users to fill better BUG reports ?
>| 
>| The usage is quite simple, put the attached file in
>| /usr/src/linux/scripts and then:
>| 
>| [root@frodo scripts]# ./report-bug.sh /tmp/BUGREPORT/
>| cat: /proc/scsi/scsi: No such file or directory
>| 
>| [root@frodo scripts]# ls /tmp/BUGREPORT/
>| cpuinfo.bug  ioports.bug  modules.bug  software.bug
>| iomem.bug    lspci.bug    scsi.bug     version.bug
>| 
>| Now you can simply attach all the .bug files to the bugzilla report or
>| inline them in a email.
>| 
>| The script is rude but it is enough to give you an idea of what I have in mind.
>| 
>| Any comment ?
>
>It can be useful.  We certainly see bug reports with a good bit
>of missing information.
>
>I would rather see the script write all /proc etc. contents to just
>one file (with some headings prior to each file).  One file would be
>easier to email inline or to attach...
>
>---
>~Randy
>-
>To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
>the body of a message to majordomo@vger.kernel.org
>More majordomo info at  http://vger.kernel.org/majordomo-info.html
>Please read the FAQ at  http://www.tux.org/lkml/
>
>  
>
We talk about it (me and Paolo) in private correspondence.

Here is my version:
http://stud.wsi.edu.pl/~piotrowskim/files/ort/ort-a5.tar.bz2

Here is my topic on kerneltrap:
http://kerneltrap.org/node/5325

If you have any suggestions, coments, please send me email or post on 
kerneltrap.

Regards,
Michał Piotrowski

Re: Script to help users to report a BUG

[randy_dunlap]

On Wed, 22 Jun 2005 22:52:49 +0200 Micha__ Piotrowski wrote:

| Hi,
| 
| randy_dunlap napisa__(a):
| 
| >On Sun, 19 Jun 2005 22:32:16 +0200 Paolo Ciarrocchi wrote:
| >
| >| Hi all,
| >| what do you think about this simple idea of a script that could help
| >| users to fill better BUG reports ?
| >| 
| >| The usage is quite simple, put the attached file in
| >| /usr/src/linux/scripts and then:
| >| 
| >| [root@frodo scripts]# ./report-bug.sh /tmp/BUGREPORT/
| >| cat: /proc/scsi/scsi: No such file or directory
| >| 
| >| [root@frodo scripts]# ls /tmp/BUGREPORT/
| >| cpuinfo.bug  ioports.bug  modules.bug  software.bug
| >| iomem.bug    lspci.bug    scsi.bug     version.bug
| >| 
| >| Now you can simply attach all the .bug files to the bugzilla report or
| >| inline them in a email.
| >| 
| >| The script is rude but it is enough to give you an idea of what I have in mind.
| >| 
| >| Any comment ?
| >
| >It can be useful.  We certainly see bug reports with a good bit
| >of missing information.
| >
| >I would rather see the script write all /proc etc. contents to just
| >one file (with some headings prior to each file).  One file would be
| >easier to email inline or to attach...
| >
| >---
| >  
| >
| We talk about it (me and Paolo) in private correspondence.
| 
| Here is my version:
| http://stud.wsi.edu.pl/~piotrowskim/files/ort/ort-a5.tar.bz2
| 
| Here is my topic on kerneltrap:
| http://kerneltrap.org/node/5325
| 
| If you have any suggestions, coments, please send me email or post on 
| kerneltrap.

OK, I looked and I have a few suggestions or comments.

1.  ort.sh needs to be run as root so that lspci -vvv and lsusb -v
work as expected.  Maybe include that requirement in 'help'?
Aha, that's what root@ng02 is supposed to mean, right?
I think it should be more explicit than that.

2.  Item 2 (full description) should allow for more than one line
of input.

3.  Item 3 (keywords) probably should allow for more than one line
of input.

4.  Item 4 (kernel version) and all of 7 (Environment) assume that
the oops happened on the system where the oops report is being
produced.  That's probably correct lots of the time, but not always.
But I don't know what to do about it.

5.  Item 7 (small sample program to duplicate problem):  at least put
an empty reminder at this spot, this is a Very Important Program.

6.  Use $EDITOR instead of vim if it is defined (set).

7.  Consider ending with on-screen message to email 'ort_oops.txt'
to linux-kernel@vger.kernel.org or some other appropriate Linux
mailing list.


I did use ort.sh and it produced a pretty good output file.

Thanks,
---
~Randy

Re: Script to help users to report a BUG

[Jesper Juhl]

On 6/23/05, randy_dunlap <rdunlap@xenotime.net> wrote:
> 
> 6.  Use $EDITOR instead of vim if it is defined (set).
> 
Wouldn't the very best be to try and find the editor to use in the
following order?  :

A) the value of $EDITOR (if set)
B) the value of $VISUAL (if set)
C) the first editor in a hardcoded list that exists and is executable
(a list could contain for example; vim, vi, elvis, joe, jove, nano,
pico, mcedit, emacs )...


-- 
Jesper Juhl <jesper.juhl@gmail.com>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html

Re: Script to help users to report a BUG

[randy_dunlap]

On Thu, 23 Jun 2005 20:24:15 +0200 Jesper Juhl wrote:

| On 6/23/05, randy_dunlap <rdunlap@xenotime.net> wrote:
| > 
| > 6.  Use $EDITOR instead of vim if it is defined (set).
| > 
| Wouldn't the very best be to try and find the editor to use in the
| following order?  :
| 
| A) the value of $EDITOR (if set)
| B) the value of $VISUAL (if set)
| C) the first editor in a hardcoded list that exists and is executable
| (a list could contain for example; vim, vi, elvis, joe, jove, nano,
| pico, mcedit, emacs )...

Yes, that sounds better to me.

---
~Randy

Re: Script to help users to report a BUG

[Jesper Juhl]

On 6/23/05, randy_dunlap <rdunlap@xenotime.net> wrote:
> On Thu, 23 Jun 2005 20:24:15 +0200 Jesper Juhl wrote:
> 
> | On 6/23/05, randy_dunlap <rdunlap@xenotime.net> wrote:
> | >
> | > 6.  Use $EDITOR instead of vim if it is defined (set).
> | >
> | Wouldn't the very best be to try and find the editor to use in the
> | following order?  :
> |
> | A) the value of $EDITOR (if set)
> | B) the value of $VISUAL (if set)
> | C) the first editor in a hardcoded list that exists and is executable
> | (a list could contain for example; vim, vi, elvis, joe, jove, nano,
> | pico, mcedit, emacs )...
> 
> Yes, that sounds better to me.
> 

A similar thing could be done for sending the email;

Look for known email clients - like mutt, pine, elm, check they exist
and are executable, then check if sendmail is available.  Present the
user with a list of the email clients found (and sendmail, if found
and local MTA process is running) and then ask them to pick their
prefered email client/sending method from the list.

-- 
Jesper Juhl <jesper.juhl@gmail.com>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html

Re: Script to help users to report a BUG

[Michał Piotrowski]

Here is latest version:
http://stud.wsi.edu.pl/~piotrowskim/files/ort/ort-a9.tar.bz2

Changelog:
- Stuff form Jesper (spelling correction ;), more editors, sendmail 
should work)

Regards,
Michał Piotrowski

Re: Script to help users to report a BUG

[Michał Piotrowski]

Hi,

Paolo Ciarrocchi wrote:

>
>Jus tried, it works well.
>
>How about adding this patch, or something like that ?
>
>--- ort.sh	2005-06-23 19:45:54.000000000 +0200
>+++ ort-new.sh	2005-06-23 21:56:25.655604560 +0200
>@@ -507,6 +507,7 @@ send_r() {
> 	    then
> 		echo -e "\nPlease email $ORT_F to linux-kernel@vger.kernel.org"
> 		echo -e "or some other appropriate Linux mailing list."
>+		echo -e "And please, use this information to file a BUG in the
>kernel Bugzilla you'll find at bugme.osdl.org. Thanks "
> 	        END=1
>         fi
>     done
>
>It seems to that there is a general agreement that all the BUG should
>be filed in bugzilla too.
>
>  
>
Ok. Good idea.
How can we do automatic posts on bugzilla? Is it possible?

For future:
We need something like ORT-HOWTO in Documentation.

Regards,
Michał piotrowski

Re: Script to help users to report a BUG

[Michał Piotrowski]

Hi,
Paolo Ciarrocchi wrote:

>One comment Michal,
>I don't like the selection of the editor, I still prefer the idea
>behind the following patch (that doesn't apply anymore)
>
>-echo "[2.] Full description of the problem/report: (press Return when done)"
>+echo "[2.] Full description of the problem/report: (end with a line
>+containing only a '.')"
>echo -e "\n[2.] Full description of the problem/report:" >> $ORT_F
>read TXT
>echo "$TXT" >> $ORT_F
>+while [ "$TXT" != "." ]  ; do
>+    read TXT
>+    echo "$TXT" >> $ORT_F
>+done
>
>Do see you the idea ? We don't need an editor to file the BUG.
>My original idea was to have a very simple and efficient script.
>
>Hope it helps.
>
>  
>
Good idea (for me). Randy what do you think about it?

Re: Script to help users to report a BUG

[randy_dunlap]

On Fri, 24 Jun 2005 08:52:13 +0200 Micha__ Piotrowski wrote:

| Hi,
| Paolo Ciarrocchi wrote:
| 
| >One comment Michal,
| >I don't like the selection of the editor, I still prefer the idea
| >behind the following patch (that doesn't apply anymore)
| >
| >-echo "[2.] Full description of the problem/report: (press Return when done)"
| >+echo "[2.] Full description of the problem/report: (end with a line
| >+containing only a '.')"
| >echo -e "\n[2.] Full description of the problem/report:" >> $ORT_F
| >read TXT
| >echo "$TXT" >> $ORT_F
| >+while [ "$TXT" != "." ]  ; do
| >+    read TXT
| >+    echo "$TXT" >> $ORT_F
| >+done
| >
| >Do see you the idea ? We don't need an editor to file the BUG.
| >My original idea was to have a very simple and efficient script.
| >
| >Hope it helps.
| >
| >  
| >
| Good idea (for me). Randy what do you think about it?

Yes, I prefer this over using an editor.

thanks,
---
~Randy

Re: Script to help users to report a BUG

[Michał Piotrowski]

Hi,

Here is the latest version:
http://stud.wsi.edu.pl/~piotrowskim/files/ort/ort-a10.tar.bz2

Changelog:
- Paolo's text input method - txt_read() (old is txt_read_ed() it's only 
a test ;))
- now only root [uid=0] may run script
- small optimalisations (point 8 etc.)

Todo:
- more email clients
- bugzilla automatic posts?
- documentation

Regards,
Michał Piotrowski

Re: Script to help users to report a BUG

[Martin J. Bligh]

--Paolo Ciarrocchi <paolo.ciarrocchi@gmail.com> wrote (on Friday, June 24, 2005 14:09:18 +0200):

> 2005/6/24, Paolo Ciarrocchi <paolo.ciarrocchi@gmail.com>:
>> 2005/6/24, Micha³ Piotrowski <piotrowskim@trex.wsi.edu.pl>:
>> > Hi,
>> > 
>> > Here is the latest version:
>> > http://stud.wsi.edu.pl/~piotrowskim/files/ort/ort-a10.tar.bz2
>> > 
>> > Changelog:
>> > - Paolo's text input method - txt_read() (old is txt_read_ed() it's only
>> > a test ;))
>> > - now only root [uid=0] may run script
>> > - small optimalisations (point 8 etc.)
>> > 
>> > Todo:
>> > - more email clients
>> > - bugzilla automatic posts?
> 
> May be Martin can help us ?
> automatic post to bugzilla would be a great things!

Not really keen on that ... when the script goes wrong, it'll potentially
file bugs at a huge rate. Plus you'd have to fill out fields, etc properly.

M.

Re: Script to help users to report a BUG

[Michał Piotrowski]

Hi all,

Here is new version:
http://stud.wsi.edu.pl/~piotrowskim/files/ort/ort-a6.tar.bz2

Small changes:
- dmesg patch (Paolo Ciarrocchi)
- add date to ort_oops

Regards,
Michał Piotrowski

Re: Script to help users to report a BUG

[Michał Piotrowski]

Hi,

Here is new "big" version:
http://stud.wsi.edu.pl/~piotrowskim/files/ort/ort-a7.tar.bz2

Changes... You will see ;).

Todo:
raport sending!!!

Thans for patches.

Regards,
Michał Piotrowski

Re: Script to help users to report a BUG

[Michał Piotrowski]

Hi,

Here is the latest verion:
http://stud.wsi.edu.pl/~piotrowskim/files/ort/ort-a8.tar.bz2

Changelog:
- Randy's patch
- Jesper's idea (Great thanks. I haven't test it yet ;))
- Tainted kernel detection ;)
- Some code "reorganization"

Regards,
Michał Piotrowski

Re: Script to help users to report a BUG

[Jesper Juhl]

On Thu, 23 Jun 2005, [ISO-8859-2] Micha? Piotrowski wrote:

> Hi,
> 
> Here is the latest verion:
> http://stud.wsi.edu.pl/~piotrowskim/files/ort/ort-a8.tar.bz2
> 
> Changelog:
> - Randy's patch
> - Jesper's idea (Great thanks. I haven't test it yet ;))
> - Tainted kernel detection ;)
> - Some code "reorganization"
> 

Here's a small patch with a few suggested changes. I don't know if you'll 
like all the changes, but feel free to use the bits you like and drop the 
rest :-)


--- ort.sh.original	2005-06-23 20:37:07.000000000 +0200
+++ ort.sh	2005-06-23 20:55:19.000000000 +0200
@@ -4,17 +4,17 @@
 # Copyright (C) 2005  Paolo Ciarrocchi <paolo.ciarrocchi@gmail.com>
 # Copyright (C) 2005  Paul TT <paultt@bilug.linux.it>
 # Copyright (C) 2005  Randy Dunlap <rdunlap@xenotime.net>
-
+#
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation; either version 2 of the License, or
 # (at your option) any later version.
-		
+#		
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
-				
+#				
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
@@ -23,16 +23,16 @@
 ORT_O=$1
 VER=v.a8
 
-M_EMAIL=a@b.c
-U_EMAIL=user@email
+M_EMAIL=joe.random.maintainer@somewhere.domain.example
+U_EMAIL=reporter@mylinuxbox.domain.example
 LKML=linux-kernel@vger.kernel.org
-TOPIC=ORT
+TOPIC="Automagically generated bug report (ORT)"
 
 EDITOR=vim
 EM_CLI=mutt
 
 help() {
-    echo "Usage: [root@ng02 ort]$ ./ort.sh oops.txt"
+    echo "Usage: [root@mylinuxbox ~]$ ./ort.sh oops.txt"
     echo "You need to be root to run the script"
     exit 1
 }
@@ -43,7 +43,7 @@
 	    help
     elif [[ ! -f "$ORT_O" ]]
 	then
-	    echo "ERROR: You must give proper file with Oops"
+	    echo "ERROR: You must provide a proper file with the Oops text"
 	    help
 	    exit 1
     fi
@@ -62,11 +62,11 @@
     echo "OOPS Reporting Tool $VER" > $ORT_F
 }
 
-chose_editor() {
+choose_editor() {
     END_B=0
     while [ $END_B = 0 ]
     do
-	echo -e "\nChose Your favourite text editor"
+	echo -e "\nChoose Your favourite text editor"
 	echo -e "1 - vim"
 	echo -e "2 - emacs"
 	echo -e "3 - mcedit"
@@ -91,7 +91,7 @@
 	        do
 	        	echo -e "\nWrite editor name"
 			read EDITOR
-			echo -e "You wrote < $EDITOR > is it corect?"
+			echo -e "You wrote < $EDITOR > is it correct?"
 		        echo -e "[Y(es)/N(o)]"
 			read TXT
 			if [ $TXT = "Y" ] || [ $TXT = "y" ]
@@ -107,11 +107,11 @@
     done
 }
 
-chose_em_cli() {
+choose_em_cli() {
     END_B=0
     while [ $END_B = 0 ]
     do
-	echo -e "\nChose Your favourite (and configured) email client (i haven't test it ;))"
+	echo -e "\nChoose Your favourite (and configured) email client (I have not tested it ;))"
 	echo -e "1 - mutt (it may not work)"
 	echo -e "2 - sendmail"
 	echo -e "o - other"
@@ -131,7 +131,7 @@
 	        do
 	        	echo -e "\nWrite email client name"
 			read EM_CLI
-			echo -e "You wrote < $EM_CLI > is it corect?"
+			echo -e "You wrote < $EM_CLI > is it correct?"
 		        echo -e "[Y(es)/N(o)]"
 			read TXT
 			if [ $TXT = "Y" ] || [ $TXT = "y" ]
@@ -188,7 +188,8 @@
     if [ "$TAINTED" > "$NULL" ]
 	then
 	    echo "Tainted kernel!!!"
-	    echo "You can't send it to LKML"
+	    echo "Please reproduce with an untainted kernel before you send the report to LKML."
+	    echo "This script will not allow you to send a report for a tainted kernel."
 	    LKML=banned@banned.org
     fi
 }
@@ -242,7 +243,7 @@
 }
 
 point_7_8() {
-    echo -e "\n[7.8.] Dmesg log" >> $ORT_F
+    echo -e "\n[7.8.] dmesg log" >> $ORT_F
     dmesg -s 100000 >> $ORT_F
 }
 
@@ -254,7 +255,7 @@
 #echo -e "\n[7.9.] /proc copy"
 #while [ $END = 0 ]
 #do
-#    echo -e "\nDo You want to create /proc copy?"
+#    echo -e "\nDo you want to create /proc copy?"
 #    echo -e "[Y(es)/N(o)]"
 #    read TXT
 #    if [ $TXT = "Y" ] || [ $TXT = "y" ]
@@ -278,7 +279,7 @@
 END=0
 while [ $END = 0 ]
 do
-    echo -e "\nDo You want to pass the path to kernel .config file?"
+    echo -e "\nDo you want to manually enter the path to the kernels .config file?"
     echo -e "[A(utomagic)/Y(es)/S(kip)]"
     read TXT
     if [ $TXT = "Y" ] || [ $TXT = "y" ]
@@ -327,7 +328,7 @@
     END=0
     while [ $END = 0 ]
     do
-	echo -e "\nDo You want to see $ORT_F?"
+	echo -e "\nDo you want to see $ORT_F?"
         echo -e "[Y(es)/N(o)]"
 	read TXT
         if [ $TXT = "Y" ] || [ $TXT = "y" ]
@@ -345,7 +346,7 @@
     END=0
     while [ $END = 0 ]
     do
-	echo -e "\nDo You want to edit $ORT_F in $EDITOR?"
+	echo -e "\nDo you want to edit $ORT_F in $EDITOR?"
         echo -e "[Y(es)/N(o)]"
 	read TXT
         if [ $TXT = "Y" ] || [ $TXT = "y" ]
@@ -363,7 +364,7 @@
     END_A=0
     while [ $END_A = 0 ]
     do
-	echo -e "\nDo you want to list MAINTERNERS list?"
+	echo -e "\nDo you want to list the MAINTERNERS file to locate the proper maintainer?"
         echo -e "[Y(es)/N(o)]"
 	read TXT
 	if [ $TXT = "Y" ] || [ $TXT = "y" ]
@@ -384,7 +385,7 @@
     END_A=0
     while [ $END_A = 0 ]
     do
-	echo -e "\nWrite mainterner e-mail"
+	echo -e "\nWrite maintainer e-mail"
 	read M_EMAIL
 	echo -e "You wrote < $M_EMAIL > is it corect?"
         echo -e "[Y(es)/N(o)]"
@@ -403,7 +404,8 @@
     END_A=0
     while [ $END_A = 0 ]
     do
-	echo -e "\nWrite your e-mail"
+	echo -e "\nWrite your e-mail (to be used as from address)"
+	echo -e "Please make sure it's correct so people can get back to you."
 	read U_EMAIL
 	echo -e "You wrote < $U_EMAIL > is it corect?"
         echo -e "[Y(es)/N(o)]"
@@ -422,7 +424,7 @@
     END=0
     while [ $END = 0 ]
     do
-        echo -e "\nDo You want to send $ORT_F?"
+        echo -e "\nDo you want to send $ORT_F?"
 	echo -e "[Y(es)/N(o)]"
         read TXT
 	if [ $TXT = "Y" ] || [ $TXT = "y" ]
@@ -433,8 +435,8 @@
 		while [ $END_1 = 0 ]
 	        do
 		    echo -e "1 to LKML"
-		    echo -e "2 to mainterner"
-		    echo -e "3 to mainterner and LKML"
+		    echo -e "2 to maintainer"
+		    echo -e "3 to maintainer and LKML"
 	            read TXT_1
 		    if [ $TXT_1 = "1" ]
 		        then
@@ -443,7 +445,7 @@
 				    mutt -s "[OOPS] $TOPIC" -i $ORT_F -c $LKML
 			    elif [ $EM_CLI = "sendmail" ]
 				then
-				    echo -e "Subject: Automagically generated bug report\n`cat topic.txt`\n" | sendmail -f <$U_EMAIL> $LKML
+				    echo -e "Subject: ${TOPIC}\n`cat ${ORT_F}`\n" | sendmail -f $U_EMAIL $LKML
 			    fi
 			    END_1=1
 	            elif [ $TXT_1 = "2" ]
@@ -472,17 +474,14 @@
 rm_ortmp
 logo
 
-chose_editor
-chose_em_cli
+choose_editor
+choose_em_cli
 
 point_1
 point_2
 point_3
-
 point_4
-
 point_5
-
 point_6
 
 point_7_1
@@ -496,11 +495,10 @@
 #point_7_9
 
 point_8
-
 point_9
 
 less_r
 edit_r
 send_r
 
-rm_ortmp
\ No newline at end of file
+rm_ortmp




Kind regards,

Jesper Juhl

Re: Script to help users to report a BUG

[randy_dunlap]

[-- Attachment #1: Type: text/plain, Size: 620 bytes --]

On Thu, 23 Jun 2005 14:06:26 +0200 Micha__ Piotrowski wrote:

| Hi,
| 
| Here is new "big" version:
| http://stud.wsi.edu.pl/~piotrowskim/files/ort/ort-a7.tar.bz2
| 
| Changes... You will see ;).
| 
| Todo:
| raport sending!!!
| 
| Thans for patches.

Here are more comments and a patch for you (attached).

ver. a7:

output file with '/' didn't work for me; changed to hyphens;
just one one tmp file name (not several p?.txt);
write the input TXT lines to the temp file before calling editor;
remove the tmp file at end;

I think that the editor and email client Q&A is overkill.

---
~Randy

[-- Attachment #2: ort.sh.a7.patch --]
[-- Type: application/octet-stream, Size: 2637 bytes --]

--- ort.sh.a7	2005-06-23 04:59:29.000000000 -0700
+++ ort.sh	2005-06-23 10:14:33.000000000 -0700
@@ -16,7 +16,7 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 			    
-ORT_F=ort_oops-`date +%x`.txt
+ORT_F=ort_oops-`date +%F`.txt
 VER=v.a7
 
 M_EMAIL=a@b.c
@@ -128,9 +128,9 @@
     done
 }
 
-if [[ -f p?.txt ]]
+if [[ -f ortmp.txt ]]
     then
-	rm p?.txt
+	rm ortmp.txt
 fi
 
 if [[ -z "$1" || "$1" = "--help" ]]
@@ -154,21 +154,24 @@
 echo "[1.] One line summary of the problem: (press Return to continue)"
 echo -e "\n[1.] One line summary of the problem:" >> $ORT_F
 read TXT
-$EDITOR p1.txt
-cat p1.txt >> $ORT_F
+echo $TXT > ortmp.txt
+$EDITOR ortmp.txt
+cat ortmp.txt >> $ORT_F
 
 echo "[2.] Full description of the problem/report: (press Return to continue)"
 echo -e "\n[2.] Full description of the problem/report:" >> $ORT_F
 read TXT
-$EDITOR p2.txt
-cat p2.txt >> $ORT_F
+echo $TXT > ortmp.txt
+$EDITOR ortmp.txt
+cat ortmp.txt >> $ORT_F
 
 echo "[3.] Keywords (i.e., modules, networking, kernel): (press Return to continue)"
 echo -e "\n[3.] Keywords (i.e., modules, networking, kernel):" >> $ORT_F
 read TXT
+echo $TXT > ortmp.txt
 #TOPIC=$TXT
-$EDITOR p3.txt
-cat p3.txt >> $ORT_F
+$EDITOR ortmp.txt
+cat ortmp.txt >> $ORT_F
 
 echo -e "\n[4.] Kernel version (from /proc/version):" >> $ORT_F
 cat /proc/version >> $ORT_F
@@ -179,8 +182,9 @@
 echo -e "\n[6.] A small shell script or example program which triggers the problem (if possible): (press Return to continue)"
 echo -e "\n[6.] A small shell script or example program which triggers the problem (if possible):" >> $ORT_F
 read TXT
-$EDITOR p6.txt
-cat p6.txt >> $ORT_F
+echo $TXT > ortmp.txt
+$EDITOR ortmp.txt
+cat ortmp.txt >> $ORT_F
 
 echo -e "\n[7.] Environment" >> $ORT_F
 
@@ -276,8 +280,14 @@
 echo -e "\n[9.] Other notes, patches, fixes, workarounds: (press Return to continue)"
 echo -e "\n[9.] Other notes, patches, fixes, workarounds:" >> $ORT_F
 read TXT
-$EDITOR p9.txt
-cat p9.txt >> $ORT_F
+echo $TXT > ortmp.txt
+$EDITOR ortmp.txt
+cat ortmp.txt >> $ORT_F
+
+if [[ -f ortmp.txt ]]
+    then
+	rm ortmp.txt
+fi
 
 END=0
 while [ $END = 0 ]
@@ -345,8 +355,8 @@
 	    done	    
     elif [ $TXT = "N" ] || [ $TXT = "n" ]
 	then
-	    echo -e "\nPlease email $ORT_F to linux-kernel@vger.kernel.org or "
-	    echo -e "some other appropriate Linux mailing list."
+	    echo -e "\nPlease email $ORT_F to linux-kernel@vger.kernel.org "
+	    echo -e "or some other appropriate Linux mailing list."
 	    END=1
     fi
-done
\ No newline at end of file
+done

Re: Script to help users to report a BUG

[Vara Prasad]

Paolo Ciarrocchi wrote:

>Hi all,
>what do you think about this simple idea of a script that could help
>users to fill better BUG reports ?
>
>The usage is quite simple, put the attached file in
>/usr/src/linux/scripts and then:
>
>[root@frodo scripts]# ./report-bug.sh /tmp/BUGREPORT/
>cat: /proc/scsi/scsi: No such file or directory
>
>[root@frodo scripts]# ls /tmp/BUGREPORT/
>cpuinfo.bug  ioports.bug  modules.bug  software.bug
>iomem.bug    lspci.bug    scsi.bug     version.bug
>
>Now you can simply attach all the .bug files to the bugzilla report or
>inline them in a email.
>
>The script is rude but it is enough to give you an idea of what I have in mind.
>
>Any comment ?
>
>
>  
>
Hi,

We have a need for similar tool so that customers using Linux system can 
report the problem with as much information as they can about their 
system for someone to diagnose the problem efficiently. Customers wanted 
to run this one tool which gathers most useful information for all kinds 
of problems. To help in this process we have a tool developed by local 
university students. I would say the tool is in prototype stage. You can 
download the tool from the project website at 
http://sourceforge.net/projects/projectsynfo.

Is the information this tool collects meets the need for what is 
discussed here?
If not what changes you would like to see in the data collected?

Currently the tool is written in "C",  if people don't like this to be 
implemented in "C", please suggest the alternatives and we can make the 
required changes.

Thanks,
Vara Prasad