Come formulare quesiti tecnici al forum

Premessa

Come indicato nel regolamento di http://forum.debianizzati.org, è raccomandabile che i quesiti tecnici siano formulati in modo da essere sufficientemente informativi: un quesito ben posto, infatti, è generalmente la premessa ad una risposta rapida e, spesso, soddisfacente sia per chi la pone che per chi la riceve (per una più approfondita lettura si rimanda a "How To Ask Questions The Smart Way").

Peraltro, è indicativo di poca educazione del richiedente impegnare - inutilmente - il tempo dei propri corrispondenti a fronte di descrizioni intenzionalmente poco comprensibili o omissive di elementi fondamentali.

Obiettivo

Il presente documento intende suggerire ai frequentatori del forum un metodo ed alcune istruzioni operative per corredare di elementi oggettivi un eventuale quesito tecnico; ciò sia allo scopo di analizzarlo nel miglior modo possibile che di proporre eventuali suggerimenti e/o soluzioni il più possibile pertinenti. Resta inteso che le istruzioni operative suggerite:

• rappresentano solo un atto di indirizzo ed hanno carattere puramente esemplificativo poiché non possono essere esaustive dell'infinito numero di possibili quesiti; l'utente, di volta in volta, potrà aggiungere o rimuovere le istruzioni che riterrà opportune o che gli/le saranno suggerite nel forum;
• non sostituiscono la preliminare "fase istruttoria" (precedente all'invio del quesito) di cui all'articolo 6 del regolamento del forum;

Metodo

Il metodo qui suggerito prevede l'uso di registrazioni informatiche relative al funzionamento del software e dell'hardware (in gergo tecnico, log). In particolare, si ricorda che:

• il sistema operativo Debian GNU/Linux genera sistematicamente log di sistema durante le sue ordinarie attività: i principali log possono essere consultati nella directory /var/log/ accessibile all'utente root[1];
• altri log possono essere generati quando necessario ricorrendo, ad esempio, al comando script[2]: alcuni esempi sono indicati nel paragrafo successivo. Si ricorda che il comando script è utilizzato generalmente in modalità interattiva (consultare la pagine di manuale di script per maggiori dettagli).

Si raccomanda, quindi, di includere nei messaggi contenenti i quesiti tecnici:

1. una descrizione accurata del fenomeno osservato;
2. i riferimenti dell'eventuale documentazione già reperita e consultata; validi riferimenti per potersi documentare sono:
   1. la guida all'installazione di Debian [3]
   2. le note di rilascio di Debian (ad esempio, della corrente versione "stabile" [4])
   3. la guida di riferimento di Debian [5]
   4. il "wiki" di Debian [6]
   5. le guide del forum http://forum.debianizzati.org guide.debianizzati.org/
   6. la funzione di ricerca del forum stesso [7]
3. l'indicazione della versione di Debian[8] e dell'architettura[9] utilizzata;
4. una descrizione accurata dell'hardware (produttore e modello) interessato al quesito, preferibilmente con riferimento alle specifiche tecniche (ad esempio, il manuale d'uso) documentate sul sito internet del produttore;
5. gli stralci dei file di log ritenuti pertinenti; in tal caso, nel testo del messaggio del forum, è preferibile che all'inzio dello stralcio sia posto il tag [CODE] ed alla fine il tag [/CODE] in modo che il testo interposto sia formattato come "codice";
6. in alternativa, è possibile - dopo averli valutati - sottoporre i file di log nella loro interezza all'attenzione del forum: a tal fine, si può ricorrere:
   1. a servizi gratuiti (come, ad esempio, http://paste.debian.net/) che permettono di condividere, per un periodo limitato, i contenuti desiderati attraverso una URL temporanea ; in tal caso, quest'ultima URL dovrà essere trascritta nel testo del messaggio;
   2. alla funzione del forum che consente di allegare un file (ad esempio, in formato gzip) al messaggio contenente il quesito (entro il limite massimo di dimensione automaticamente imposto dal software del forum);
7. nei casi di anomalie particolarmente difficili da documentare, e se tecnicamente possibile, si consiglia di allegare fotografie o riferimenti a brevi registrazioni video di ciò che compare sullo schermo del computer al momento dell'anomalia.

Istruzioni operative

Si raccomanda di indicare sempre le principali caratteristiche tecniche della propria installazione Debian GNU/Linux. A tal fine, è possibile impartire, ad esempio, da una finestra di terminale (quindi, in modalità interattiva) i seguenti comandi:

script log.txt
lsb_release -a
dmesg
su -l -c "lspci -knn"
lsusb
su -l -c "lsusb -v"
exit
gzip -c log.txt > log.gz

che genereranno un file di log chiamato log.txt che conterrà le seguenti informazioni:

• la versione di debian installata (comando lsb_release -a);
• il log del kernel a partire dall'avvio del sistema (comando dmesg);
• l'elenco delle periferiche PCI (comando lspci) e USB (comando lsusb) riconosciute dal sistema operativo (nota: il comando su richiederà l'inserimento della password dell'utente root, cioè dell'amministratore di sistema).

Le stesse informazioni sono disponibili nel file compresso in formato gzip chiamato log.gz.

A discrezione del richiedente ed in funzione del tipo di quesito è, naturalmente, possibile generare log relativi ad altri e più specifici aspetti del funzionamento del sistema operativo o di specifiche applicazioni; ad esempio, è possibile impartire i seguenti comandi:

script log2.txt
mount
cat /etc/fstab
cat /etc/network/interfaces
ip add
ip route
cat /etc/apt/sources.list
cat /etc/X11/xorg.conf
su -l -c "cat /var/log/Xorg.0.log"
su -l -c "aptitude install wget"
wget http://www.alsa-project.org/alsa-info.sh
bash ./alsa-info.sh --stdout --no-upload
exit
gzip -c log2.txt > log2.gz

che genereranno un file di log chiamato log2.txt che conterrà le seguenti informazioni:

• l'elenco delle partizioni disco montate (comando mount) e la configurazione dei file system del sistema (file /etc/fstab);
• la configurazione del sistema di rete (file /etc/network/interface) e l'attuale stato delle periferiche di rete (comando ip);
• la configurazione del gestore di pacchetti (file /etc/apt/sources.list);
• la configurazione del server X (file /etc/X11/xorg.conf, se presente) ed il file di log relativo al suo funzionamento (file /var/log/Xorg.0.log);
• la configurazione del sistema audio ALSA e delle librerie correlate (script alsa-info.sh prelevato dal sito del progetto ALSA usando il programma wget di cui è verificata ed eventualmente effettuata l'installazione con il comando aptitude install wget).

Le stesse informazioni sono disponibili nel file compresso in formato gzip chiamato log2.gz.

Creazione automatica di un file di log

Per quanti desiderassero generare automaticamente un file di log è possibile far riferimento ad una guida specifica per la Creazione automatica di un file di log per inviare quesiti al forum.

Conclusioni

Il presente documento intende suggerire un metodo per corredare di un'adeguata documentazione i quesiti tecnici formulati nel forum. Ciò allo scopo di:

• oggettivare correttamente il fenomeno descritto ai propri corrispondenti nel forum;
• fornire, nel più breve tempo possibile, gli elementi tecnici necessari a rispondere;
• permettere a terzi di riprodurre il fenomeno qualora esso sia causato da un malfunzionamento sistematico.

In ultima analisi, tutto questo per rendere Debian GNU/Linux sempre migliore ed aumentare il livello di conoscenza di chi lo utilizza.

Commenti

I commenti a questo documento sono richiesti e ben accetti; possono essere inoltrati nella sezione Guide@Debianizzati.Org del forum.

Riferimenti

1) Debian Reference Guida, 9.2.1. Demoni di registro, https://www.debian.org/doc/manuals/debian-reference/ch09.it.html#_the_log_daemon

2) Debian Reference Guida, 1.4.9. Registrare le attività della shell, https://www.debian.org/doc/manuals/debian-reference/ch01.it.html#_recording_the_shell_activities

3) Debian Installation Guide, http://www.debian.org/releases/stable/installmanual.it.html

4) Debian Release Notes for Stable release, http://www.debian.org/releases/stable/installmanual.it.html

5) Debian Reference Guide, Table of Contents, https://www.debian.org/doc/manuals/debian-reference/index.it.html

6) Debian Wiki, Main Page, https://wiki.debian.org/it/FrontPage

7) Guide del Forum Debianizzati.org, Indice Guide

8) Forum Debianizzati.org, funzione di ricerca, http://forum.debianizzati.org/search.php

9) Versioni e rilasci di Debian, https://www.debian.org/releases/index.it.html

10) Architetture supportate dal progetto Debian, https://www.debian.org/ports/index.it.html

11) Regolamento Forum Debianizzati.org, http://forum.debianizzati.org/viewtopic.php?f=25&t=40984

--- Lo staff di Debianizzati.Org