| Documenti Firebird → Agli scrittori per Firebird → Scrivere documenti per Firebird → Aggiungere il testo al modulo |
|
|
|
Finito il testo, e verificato che si ricostruisce correttamente, si può aggiungerlo al modulo del manuale. Per il primo contributo al progetto della documentazione ci si accorda con uno dei coordinatori per una prima revisione, oppure si può mettere la versione HTML su un sito per discuterne nella lista. Poi, e dopo che sono state fatte tutte le possibili correzioni, il documento può essere depositato nel modulo. Avendo i diritti di commit, si può farlo autonomamente; senza questi diritti bisogna che venga fatto da uno dei coordinatori.
Per ottenere i diritti di deposito, è prima necessario avere un accesso a SourceForge. Per averlo, bisogna registrarsi a http://sourceforge.net/account/register.php (purtroppo, finora, il sistema di registrazione è solo in inglese). Poi si invia un messaggio alla lista firebird-docs indicando il vostro nome utente e chiedendo di essere aggiunto al progetto Firebird. Il responsabile del sottoprogetto del manuale e altri amministratori del progetto Firebird seguono la lista: valuteranno pertanto la richiesta di ingresso. Come regola generale si dovrebbe chiedere i diritti di scrittura solo dopo il primo contributo, perchè chi decide ha bisogno di una base sulla quale farsi un'opinione.
Le seguenti frasi al momento hanno lo stesso significato, pertanto:
Essere un membro del progetto.
Avere i diritti di deposito.
Avere accesso in lettura e scrittura alla repository del progetto.
Una volta accettato come membro del progetto, si ha diritti di scrittura a tutta la repository del progetto, non solo al modulo del manuale. Non esiste nessuna barriera tecnica per impedire il deposito di modifiche ad altri moduli, come il modulo centrale di firebird2, o perfino al modulo CVSROOT dove sono conservati importanti informazioni del progetto.
È chiaro che certe cose non devono passare neanche per l'anticamera del cervello. Vanno seguite le seguenti regole:
Non depositare mai in altri moduli a meno che i responsabili di quei particolari moduli non l'abbiano chiesto esplicitamente.
Depositare solo lavori nel modulo del manuale che siano relativi ad un compito assegnato esplicitamente a voi. Perfino in quel caso, è buona cosa preannunciare le modifiche e le aggiunte nella mailing list, per dare la possibilità agli altri componenti di fare eventuali commenti. In fondo, questo è un lavoro collettivo.
Ritenendo di dover aggiungere un nuovo documento o cartella, non fatelo direttamente, ma prima proponetelo alla lista.
In pratica, le cose potrebbero essere un pochino più semplici di quanto detto, specialmente riguardo al proprio lavoro. Non desideriamo che la gente si senta costretta, e certamente non si ha la voglia di chiedere il permesso di modificare la più piccola cosa del proprio lavoro. Si desidera cooperare con gente responsabile, e desideriamo sapere cosa tutti stiamo facendo. Inoltre, mantenersi in contatto l'un l'altro è piacevole ed insieme si è in grado di fare tutto.
Pur essendo membri del progetto, si può depositare il proprio lavoro da una copia locale solo se è stata estratta col propro nome utente SF. Se si sta' ancora lavorando con una copia estratta in modo anonimo, bisogna prima fare un'estrazione SSH (SSH checkout), e poi rimettere le proprie modifiche. Solo allora si riesce a farne il deposito (commit). Le istruzioni dettagliate sono nella guida Come ricostruire i manuali di Firebird nel si siano dimenticati i particolari di come fare un'estrazione SSH.
Se è passato molto tempo dall'ultimo checkout o dall'ultimo aggiornamento, meglio farne un'altro di controllo prima di depositare. Questo rende la copia locale sincronizzata con il deposito remoto e riduce la possibilità di conflitti.
Dopo questi controlli, non appena si è pronti per depositare, si va nella directory del manuale, e, usando un CVS a linea di comando, si digita il comando:
cvs update -d [ solo se si vuole fare un aggiornamento preventivo ]
cvs add path/to/mydocument.xml [ solo se si deve aggiungere un documento nuovo non ancora in CVS ]
cvs commit -m "Breve messaggio informativo "
Dopo il -m, e all'interno degli apicini doppi, si può mettere un breve messaggio relativo a questo deposito, ad esempio "Aggiunte nuove funzioni all'API Reference" or "Corretti errori nella guida isql".
Quando richiesto bisogna inserire la propria password SF, e tutte le modifiche fatte, incluse quelle nelle sottocartelle, saranno depositate definitivamente. Il programma CVS sa quale server contattare; questo perchè le varie informazioni sono memorizzate nelle cartelle CVS che sono state create nell'estrazione, cioè durante il checkout.
Usando un altro programma CVS, com'è ovvio, fate riferimento alla sua documentazione.
Dopo aver aggiunto un nuovo documento, bisogna fare comunque un commit distinto dall'aggiunta. Questo vale per il CVS a linea di comando e per molti altri (anche se non tutti) programmi CVS.
|
| Documenti Firebird → Agli scrittori per Firebird → Scrivere documenti per Firebird → Aggiungere il testo al modulo |