Firebird Documentation IndexCome fare il manuale di Firebird → Prelevare il modulo del manuale da SF
Firebird Home Firebird Home Indietro: Come fare il manuale di FirebirdFirebird Documentation IndexRisali: Come fare il manuale di FirebirdAvanti: Ricostruire la documentazione di Firebird

Prelevare il modulo del manuale da SourceForge

Che cosa è il CVS?
I client per il CVS
Fare il "check out" del modulo del manuale

Il modulo del manuale è parte del "Firebird CVS repository" sul sito di SourceForge. Per prelevarlo si ha bisogno di un programma che viene definito un CVS client. Questa sezione descrive i passi necessari per ottenere il software e scaricare il modulo del manuale. La parte per ricostruire realmente la documentazione viene illustrata nella successiva sezione principale: Ricostruire la documentazione Firebird.

Che cosa è il CVS?

CVS è l'acronimo della frase inglese Concurrent Versions System che significa (non proprio letteralmente) "sistema per la gestione di versioni concorrenti". Di fatto è uno strumento per gestire lo sviluppo di programmi, utile a singoli sviluppatori ma sopratutto a equipe cooperanti. Praticamente tutti i progetti di SourceForge usano CVS per memorizzare e sviluppare il loro codice. Poiché ogni progetto è un deposito organizzato come un albero, così l'albero CVS di Firebird è suddiviso in più moduli, in cui il modulo del manuale è uno di questi.

I client per il CVS

Prelevare un modulo dal deposito del CVS viene detto checking out nel gergo del CVS. Per farlo si ha bisogno di un cosiddetto CVS client; ne esistono praticamente per ogni sistema operativo. Segue una lista di client CVS per alcuni dei più diffusi sistemi operativi, notare che non sono quasi mai tradotti in italiano:

Una volta ottenuto uno o più dei summenzionati software, installatelo seguendo le istruzioni allegate. Dopodiché si è pronti per fare il "check out" del modulo del manuale.

Fare il "check out" del modulo del manuale

Ci sono due modi per fare il check out di un modulo: come utente anonimo (letteralmente si chiama "anonymous"), oppure attraverso il proprio nome di accesso a SourceForge. L'ultimo metodo viene spesso chiamato "SSH checkout" perchè utilizza una interfaccia sicura (Secure SHell) oppure anche "EXT checkout", perchè usa SSH come protocollo esterno.

Chiunque può fare il checkout anonimo. I membri del progetto Firebird possono fare il checkout col proprio nome utente SourceForge. Nota bene: se si ha un accesso SourceForge ma non si è membri del progetto Firebird si può fare solo il checkout anonimo.

Chi è membro del progetto, dovrebbe eseguire il checkout attraverso il proprio nome utente SourceForge in quanto

  1. Un checkout anonimo non sempre è aggiornato e ci possono essere ritardi da qualche ora a qualche giorno;

  2. Contribuendo personalmente al modulo del manuale, si deve eseguire il checkout con il proprio nome utente SourceForge altrimenti non si possono caricare (in gergo fare il "commit") le proprie modifiche sul server di SourceForge.

Verranno descritti entrambi i metodi nelle prossime sezioni, iniziando col checkout anonimo. Clicca qui per andare alla sezione che riguarda il checkout SSH (dopo aver letto l'avvertenza seguente).

Avvertenze

  • Nel caso in cui si sia all'interno di un firewall, assicurarsi che la porta 2401 TCP sia aperta. In caso contrario non si è in grado di effettuare la connessione al server cvs. La propria connessione semplicemente viene interrotta per tempo scaduto mentre cerca ancora di collegarsi.

  • Se possibile, effettuare il checkout in un percorso locale che non contenga nei nomi delle directory spazi o altri caratteri speciali soggetti ad essere codificati come nelle URL (es.: lo spazio diventa '%20'). Altrimenti potrebbero esserci problemi ricostruendo certi tipi di documenti. Sono problemi comunque risolvibili, ma è meglio evitarli.

Checkout anonimo

La procedura di checkout anonimo dipende dal client che si usa. Adesso diamo le istruzioni esatte per il CVS a linea di comando, e di seguito le informazioni adatte per poter configurare altri software.

Checkout anonimo con CVS a linea di comando
  1. Se sei in un ambiente grafico, apri una finestra con il prompt dei comandi

  2. Per prima cosa, bisogna verificare la password e memorizzarla localmente. Per fare ciò si scrive il comando:

    cvs -d:pserver:anonymous@firebird.cvs.sourceforge.net:/cvsroot/firebird login

    Quando chiede la password, digitate direttamente il tasto di Invio, perchè la password per l'utente "anonymous" è vuota. Il programma CVS memorizza la password per i successivi usi, così da saltare questo passo in seguito perchè non si usano altre password.

  3. A questo punto si può scaricare il modulo del manuale, digitando, su una sola linea, il comando seguente :

    cvs -z6 -d:pserver:anonymous@firebird.cvs.sourceforge.net:/cvsroot/firebird checkout manual

    Se tutto va bene, viene creata una directory chiamata manual sotto la directory corrente, e l'albero completo di sorgenti del manuale viene scaricato in essa. A questo punto si può ricostruire la documentazione - per informazioni leggi Ricostruire la documentazione di Firebird.

Checkout anonimo con altri metodi

Ci sono tante configurazioni diverse per dare qui istruzioni esatte, per tutti i possibili programmi CVS client. Pertanto consultate la documentazione del programma per immettere le varie informazioni di cui potreste aver bisogno prima o poi, e che sono:

protocol

Indica il tipo di protocollo e va impostato su pserver (password server)

authentication method

Indica il metodo di autenticazione e va impostato come protocol

server

firebird.cvs.sourceforge.net cioè il nome del server su cui sono depositati i sorgenti comuni

repository

/cvsroot/firebird è la directory da indicare come origine di tutti i sorgenti comuni

user name

il nome utente, attenzione a come è scritto: anonymous

module name

manual cioè il nome del modulo da scaricare dal server

cvsroot

di solito è una combinazione tra server e repository (deposito), alle volte con il nome utente preposto (esempio WinCvs fa così): firebird.cvs.sourceforge.net:/cvsroot/firebird oppure anonymous@firebird.cvs.sourceforge.net:/cvsroot/firebird

Riempite i dati necessari e date il comando di checkout del vostro programma client. Se funziona, avrete una copia locale del modulo del manuale sul vostro computer e si è pronti per ricostruire la documentazione. Leggete quindi Ricostruire la documentazione di Firebird.

SSH checkout (col proprio nome utente SF)

Per poter effettuare un SSH checkout, bisogna che sia presente sul sistema un "secure shell client". Sulla maggior parte dei sistemi Unix, così come su Mac OS X, OpenSSH è già installato. Altrimenti, controllate sul CD della distribuzione o cercatelo da http://www.openssh.com. Questo sito contiene indirizzi anche per altri prodotti per SSH per altri sistemi operativi non supportati direttamente da OpenSSH. Notare che installare e configurare OpenSSH su alcuni sistemi (incluso Windows) non è proprio facile. Sarebbe meglio scegliere un client CVS che contiene già SSH incluso, ad esempio TortoiseCVS per Windows.

Per quanto riguarda il vero e proprio checkout, così come il checkout anonimo, la procedura dipende dal programma client usato. Daremo esatte istruzioni per il checkout a linea di comando ed istruzioni generali per altri client.

Avvertimento

Occasionalmente potrebbe scadere la propria password di SourceForge. Nel caso in cui ciò accadesse, si riceve un messaggio del tipo "Accesso negato, riprovare" (in inglese "Permission denied. Please try again"). Nel caso accadesse, ed essendo sicuri che la password sia giusta, si deve andare alla pagina principale di SourceForge - http://sourceforge.net/index.php - e cercare di fare il login con il nome utente e password con cui si era soliti connettersi al cvs. Se la password è scaduta, verrà richiesto di cambiarla.

Dopo aver cambiato la propria password, sarà necessario far partire una nuova sessione, altrimenti si continuerà a ricevere sempre il messaggio di password scaduta, anche con la nuova password.

Fare il SSH checkout con CVS a linea di comando.
  1. Se sei in ambiente grafico, apri una finestra con il prompt dei comandi.

  2. Per prima cosa, assicurarsi di avere una variabile d'ambiente chiamata CVS_RSH col valore «ssh» (o come è chiamato il tuo programma client SSH). Come farlo dipende dal sistema operativo. In ambiente DOS/Windows, usate set CVS_RSH=ssh. In Linux/bash, invece, si usa export CVS_RSH=ssh.

    Per rendere questa variabile permanente, in modo da saltare questo passo in futuro, consultate la documentazione del vostro sistema operativo se necessario.

  3. Date il seguente comando per scaricare il modulo del manuale (scrivete tutto su una sola linea e sostituite username col vostro nome utente di SourceForge):

    cvs -z6 -d:ext:username@firebird.cvs.sourceforge.net:/cvsroot/firebird checkout manual

    Inserite la vostra password quando viene richiesta.

    Se tutto funziona, verrà creata una directory chiamata manual sotto il direttorio corrente e tutto l'albero dei sorgenti vi verrà scaricato. Per ricostruire il manuale leggete Ricostruire la documentazione di Firebird.

Fare il SSH checkout con altri programmi client

Ci sono troppe diversità per dare una sequenza di istruzioni esatta per qualsiasi client CVS. Consultate l'aiuto in linea o la documentazione del vostro programma client. Gli elementi che ad un certo punto vi possono essere richiesti sono:

protocol ( o protocollo )

questo deve essere impostato a ext (o SSH, o SSL)

authentication method (o metodo di autenticazione)

allo stesso modo di come hai impostato il protocollo

server

firebird.cvs.sourceforge.net cioè il nome del server su cui sono depositati i sorgenti comuni

repository

/cvsroot/firebird è la directory da indicare come origine dell'albero di tutti i moduli sorgenti

user name

è il nome utente: usare il nome utente SourceForge

module name

manual cioè il nome del modulo da scaricare dal server

cvsroot

di solito è una combinazione di server e repository con talvolta preposto il nome utente: firebird.cvs.sourceforge.net:/cvsroot/firebird oppure, in altri casi, username@firebird.cvs.sourceforge.net:/cvsroot/firebird dove al posto di username si imposta il proprio nome utente

Cercate di immettere tutti i dati necessari richiesti dal vostro programma client CVS e date il comando di checkout. Se funziona, si crea una copia locale del modulo del manuale sul vostro computer e si possono ricostruire i documenti. Inoltre potete confermare le modifiche che fate localmente nella copia remota del modulo del manuale.

Indietro: Come fare il manuale di FirebirdFirebird Documentation IndexRisali: Come fare il manuale di FirebirdAvanti: Ricostruire la documentazione di Firebird
Firebird Documentation IndexCome fare il manuale di Firebird → Prelevare il modulo del manuale da SF