\documentclass[10pt,a4paper]{article}
\setlength{\textheight}{240mm}
\setlength{\textwidth}{160mm}
\setlength{\oddsidemargin}{0mm}
\setlength{\evensidemargin}{0mm}
\setlength{\topmargin}{-10mm}


\begin{document}

\begin{title}
{\Large Breve manuale sull'uso dei tool make e CVS}
\end{title}
\begin{author}
{\Large Simone Piccardi}
\end{author}

%\begin{abstract}
%Queste brevi note vogliono essere un'introduzione all'uso di alcuni tool di 
%costruzione dei programmi ampiamente usati nella comunit\`a degli sviluppatori,
%che consentono una facile manutanezione dei programmi, e una procedura di
%compilazione dei medesimi rapida ed efficiente. 
%\end{abstract}
\maketitle
\normalsize

\section{Make}

Il comando {\it make} serve per effettuare una compilazione intelligente di 
tutti i file relativi a un programma (subroutines e routine principale) 
ricompilando solo i file necessari. 

\subsection {Introduzione}
Con  {\it make} si possono definire i simboli del preprocessore C che 
consentono
la compilazione condizionale dei programmi (anche in Fortran); \`e pertanto 
possibile gestire la ricompilazione dei programmi con diverse configurazioni 
con la modifica di un unico file.

La sintassi normale del comando (quella che si usa quasi sempre, per le opzioni
vedere la man page) \`e semplicemente {\tt make}. Questo comando esegue le 
istruzioni contenute in un file standard (usualmente {\tt Makefile}, o 
{\tt makefile} nella directory corrente).

Il formato normale dei comandi contenuti in un {\it Makefile} \`e:
\begin{verbatim}
bersaglio: dipendenza1 dipendenza2 ...
        regola1
        regola2
        ...
\end{verbatim}
dove lo spazio all'inizio deve essere un {\tt TAB}, il bersaglio e le 
dipendenze nomi di files e le regole comandi di shell.

Il concetto di base \`e che se uno dei file di dipendenza \`e pi\`u nuovo del 
file bersaglio (sulla base della sua data di modifica) il bersaglio viene 
ricostruito usando le regole elencate sotto.

Il comando {\tt make} ricostruisce di default il primo bersaglio che viene 
trovato nella scansione del {\it Makefile}, se in un {\it Makefile} sono 
contenuti pi\`u bersagli indipendenti, si pu\`o farne ricostruire un'altro 
che non sia il primo con il comando esplicito {\tt make bersaglio}.

Si tenga presente che le dipendenze stesse possono essere dichiarate come 
bersagli dipendenti da altri file; in questo modo \`e possibile creare una 
catena di ricostruzioni. 

In esempio comune di quello che si fa \`e mettere come primo 
bersaglio il programma principale che si vuole usare, e come dipendenze 
tutte gli oggetti delle sue subroutine, con i quali deve essere linkato; a 
loro volta questi oggetti sono bersagli che hanno come dipendenza i relativi 
sorgenti. In questo modo il cambiamento di una sola delle subroutine comporta 
solo la ricompilazione della medesima e del programma finale.


\subsection{Utilizzo}
{\tt Make} mette a disposizione una serie molto complesse di opzioni e di 
regole 
standard predefinite e sottintese, che permettono una gestione estremamente 
rapida e concisa di progetti anche molto complessi; per questo piuttosto che
fare una replica del manuale preferisco commentare un esempio di makefile, 
quello usato per ricompilare i programmi di analisi dei dati dei test su
fascio del tracciatore di Pamela.

\small
\begin{verbatim}
#----------------------------------------------------------------------
#
# Makefile for a Linux System:
# use GNU FORTRAN compiler g77
# Makefile done for tracker test data
#
#----------------------------------------------------------------------
# Fortran flags
FC=g77
FFLAGS= -fvxt -fno-automatic -Wall -O6 -DPC # -DDEBUG
CC=gcc
CFLAGS= -Wall -O6
CFLADJ=-c #-DDEBUG
#
# FC            Fortran compiler for standard rules
# FFLAGS        Fortran flags for standard rules
# CC            C Compiler for standard rules
# CFLAGS        C compiler flags for standard rules 
LIBS=  -L/cern/pro/lib -lkernlib -lpacklib -lgraflib -lmathlib
OBJ=cnoise.o fit2.o pedsig.o loop.o badstrp.o cutcn.o readevnt.o \
erasepedvar.o readinit.o dumpval.o writeinit.o

riduzione: riduzione.F $(OBJ) commondef.f readfile.o
        $(FC) $(FFLAGS) -o riduzione riduzione.F readfile.o $(OBJ) $(LIBS) 

readfile.o: readfile.c
        $(CC) $(CFLAGS) -o readfile.o readfile.c

$(OBJ): commondef.f

.PHONY : clean
clean:
        rm -f *.o 
        rm -f *~
        rm -f riduzione
        rm -f *.rz
        rm -f output
\end{verbatim}
\normalsize

Anzitutto i commenti, ogni linea che inizia con un {\tt \#} \`e un
commento e non viene presa in considerazione.

Con {\it make} possono essere definite delle variabili, da potersi riusare a 
piacimento, per leggibilit\`a si tende a definirle tutte maiuscole, 
nell'esempio ne sono definite varie:
\small
\begin{verbatim}
FC=g77
FFLAGS= -fvxt -fno-automatic -Wall -O6 -DPC # -DDEBUG
CC=gcc
CFLAGS= -Wall -O6
CFLADJ=-c #-DDEBUG
...
LIBS=  -L/cern/pro/lib -lkernlib -lpacklib -lgraflib -lmathlib
OBJ=cnoise.o fit2.o pedsig.o loop.o badstrp.o cutcn.o readevnt.o \
\end{verbatim}
\normalsize
La sintassi \`e {\tt NOME=}, alcuni nomi per\`o hanno un significato speciale 
(nel caso {\tt FC}, {\tt FLAGS}, {\tt CC}, {\tt CFLAGS}) in quanto sono usati
da {\it make} nelle cosiddette {\it regole implicite} (su cui torneremo dopo).

Nel caso specifico, vedi anche i commenti, abbiamo definito i comandi di 
compilazione da usare per il C e il Fortran, e i rispettivi flag, una variabile
che contiene il path e la lista delle librerie del CERN e una variabile con una
lista di file oggetto.

Per richiamare una variabile si usa la sintassi {\tt \$(NOME)}, ad esempio nel 
makefile abbiamo usato:
\begin{verbatim}
        $(FC) $(FFLAGS) -o riduzione riduzione.F readfile.o $(OBJ) $(LIBS) 
\end{verbatim}
e questo significa che la regola verr\`a trattata come se avessimo scritto 
esplicitamente i valori delle variabili.

Veniamo ora alla parte principale del makefile che esegue la costruzione del
programma:
\begin{verbatim}
riduzione: riduzione.F $(OBJ) commondef.f readfile.o
        $(FC) $(FFLAGS) -o riduzione riduzione.F readfile.o $(OBJ) $(LIBS) 
readfile.o: readfile.c
        $(CC) $(CFLAGS) -o readfile.o readfile.c
$(OBJ): commondef.f
\end{verbatim}

Il primo bersaglio del makefile, che definisce il bersaglio di default, \`e
il programma di riduzione dei dati; esso dipende dal suo sorgente da tutti
gli oggetti definiti dalla variabile {\tt OBJ}, dal file di definizioni {\tt
commondef.f} e dalla routine C {\tt readfile.o}; si noti il {\tt .F} del
sorgente, che significa che il file prima di essere compilato viene fatto
passare attraverso il preprocessore C (cosa che non avviene per i {\tt .f})
che permette di usare i comandi di compilazione condizionale del
preprocessore C con la relativa sintassi. Sotto segue il comando di
compilazione che sfrutta le variabili definite in precedenza per specificare
quale compilatore e flags usare e specifica di nuovo gli oggetti e le
librerie.

Il secondo bersaglio definisce le regole per la compilazione della routine
in C; essa dipende solo dal suo sorgente. Si noti che per la compilazione
vengono usate le variabili relative al compilatore C. Si noti anche che se
questa regola viene usata, allora lo sar\`a anche la precedente, dato che
{\tt riduzione} dipende da {\tt readfile.o}.

Il terzo bersaglio \`e apparentemente incomprensibile dato che vi compare
solo il riferimento alla variabile {\tt OBJ} con una sola dipendenza e
nessuna regola, essa per\`o mostra le possibilit\`a (oltre che la
complessit\`a) di {\it make} connesse alla presenza di quelle regole
implicite a cui avevamo accennato.

Anzitutto una una peculiarit\`a di {\tt make} \`e che si possono anche usare
pi\`u bersagli per una stessa regola (nell'esempio quelli contenuti nella
variabile {\tt OBJ} che viene espansa in una lista); in questo caso la
regola di costruzione sar\`a applicata a ciascuno che si potr\`a citare
nella regola stessa facendo riferimento con la variabile automatica:
{\tt \$@}.
L'esempio usato per la nostra costruzione per\`o sembra non avere neanche
la regola di costruzione.

Questa mancanza sia di regola che di dipendenze (ad esempio dai vari sorgenti) 
illustra le capacit\`a di funzionamento automatico di {\it make}.
Infatti \`e facile immaginarsi che un oggetto dipenda da un sorgente, e che 
per ottenere l'oggetto si debba compilare quest'ultimo.

{\it Make} sa tutto questo per cui quando un bersaglio \`e un oggetto (cio\'e 
ha un nome tipo {\tt qualcosa.o}) non \`e necessario specificare
il sorgente, ma il programma lo va a cercare nella directory
corrente (ma \`e possibile pure dirgli di cercarlo altrove, vedi il manuale). 
Nel caso specifico allora si \`e messo come 
dipendenza solo il file delle definizioni che viene incluso in ogni 
subroutine. 
Inoltre come dicevamo in genere per costruire un oggetto si deve compilarne 
il sorgente; {\it make} sa anche questo e sulla base dell'estenzione del 
sorgente trovato (che nel caso sar\`a un {\tt qualcosa.f}) applica la regola 
implicita.
In questo caso la regola \`e quella di chiamare il compilatore fortran 
applicato al file oggetto e al relativo sorgente, questo viene fatto
usando la variabile {\tt FC} che \`e una delle variabili standard
usata dalle regole implicite (come {\tt CC} nel caso di file {\tt .c}); per
una maggiore flessibilit\`a poi la regola standard usa anche la variabile
{\tt FFLAGS} per specificare, a scelta dell'utente che non ha che da definirla,
quali flag di compilazione usare (nella documentazione sono riportate tutte
le regole implicite e le relative variabili usate).

In questo modo \`e stato possibile usare una sola riga per indicare la serie 
di dipendenze e relative compilazioni delle singole subroutine; inoltre con 
l'uso della variabile {\tt OBJ} l'aggiunta di una nuova eventuale routine 
{\tt nuova.f} comporta solo l'aggiunta di {\tt nuova.o} alla definizione di
{\tt OBJ}.

\section{Cuncurrent Version System -- CVS}

Il programma CVS \`e un sistema di archiviazione dei programmi che consente 
di tenere 
traccia di tutte le modifiche e di condividere un archivio comune per
progetti portati avanti da diverse persone.

\subsection{Introduzione}
CVS \`e basato sul concetto di repositorio, un archivio in cui vengono riposti
e da cui vengono presi i sorgenti dei programmi. L'archivio tiene traccia delle
diverse versioni registrate; i programmatori inviano le modifiche usando una 
copia locale che hanno nella loro directory di lavoro. 

CVS pu\`o gestire pi\`u di un progetto, esso organizza i progetti in {\it 
moduli} identificati dal nome della directory in cui sono messi i file 
relativi, ad esempio:
\small
\begin{verbatim}
[piccardi@pcpamela ~]$ ls /usr/local/cvsroot/ 
CVSROOT  adidsp  geometry  muonacq  pamela
\end{verbatim}
\normalsize %$
in questo caso si hanno i moduli {\it adidsp  geometry  muonacq  pamela}; un
utente potr\`a recuperare tutti i file relativi al modulo {\it pamela} che 
andaranno nella directory {\tt pamela}; \`e anche possibile gestire una 
gerarchia di moduli, inseriti in un albero di directory.

CVS ha una directory base dove tiene gli archivi (che nel \`e appunto {\tt
  /usr/local/cvsroot}) e i vari file amministrativi; ogni progetto deve fare
riferimento ad essa; in un progetto attivo essa viene memorizzata nei file
amministrativi locali del progetto (ad esempio per un utente che ha il
progetto {\it muonacq} nella sua home directory sar\`a in {\tt \~
  /muonacq/CVS}) e non \`e necessario specificarla; in generale essa viene
tenuta dalla variabile di shell {\tt CVSROOT} (inizializzata allo startup), o
specificata direttamente dall'utente con l'apposito switch {\tt -d} (ex. {\tt
  cvs -d /usr/local/cvsroot comando opzioni}).

Normalmente l'archivio si tiene su una macchina remota e vi si
accede via rete. Per repositori esterni esistono varie modalit\`a di accesso,
la via piu' semplice \`e quella dell'uso di ssh come rimpiazzo di 
rsh per l'accesso esterno; in tal caso la directory del repositorio si pu\`o
accedere con la sintassi:
\small
\begin{verbatim}
cvs -d :ext:utente@server:/usr/local/cvsroot comando
\end{verbatim}
\normalsize
questo per\`o comporta che sulla macchina remota {\tt server} sia installato 
il server {\tt ssh} ed esista l'utente {\tt utente} con privilegi di accesso 
ai files; inoltre sulla macchina ospite deve esser stata definita la variabile
di shell {\tt CVS\_RSH=ssh}.

In questo modo ssh si collega alla macchina remota ed esegue il comando CVS con
una connessione criptata dopo aver richiesto la password di {\tt utente}. 


\subsection{Utilizzo}

Per creare un repositorio a partire da un gruppo di programmi esistente basta
dare il comando {\tt cvs import project tag release} nella directory dei
sorgenti; verr\`a creato nel repositorio il modulo di nome {\it project} a cui
poi si potr\`a accedere con i successivi comandi; {\tt tag} \`e una label di
versione iniziale (ex. {\tt 1.1.1}) dato a tutto il blocco e {\tt release} una
label di versione data ai programmi.

Una volta creato il repositorio \`e d'uopo cancellare la directory e ripartire
dal progetto appena creato. Per recuperare ex-novo tutti i file di un progetto
il comando da dare \`e:
\small
\begin{verbatim}
cvs [-d ...] checkout project [-r rel] [-D date]
\end{verbatim}
\normalsize 
che creer\`a la directory {\tt project} nella directory corrente con l'ultima
versione dei file archiviata; se non si vuole la versione pi\`u aggiornata, ma
una versione precedente si pu\`o usare lo switch {\tt -r} che scaricher\`a la
versione identificata dall'etichetta specificata (vedi la parte seguente sul
comando {\tt tag}) o lo switch {\tt -D} che scaricher\`a la versione pi\`u
recente prima della data specificata.

Una volta scaricato il progetto \`e possibile evitare di specificare la
directory base del repositorio con l'opzione {\tt -d} qualora i comandi
vengano dati all'interno della directory creata, essa viene tenuta nel file
{\tt CVS/Root}, e pu\`o essere cambiata (qualora si usino pi\`u repositori)
editando detto file.

Una volta creata la propria copia locale dei programmi, \`e possibile lavorare
su di essi stando nella relativa directory,
e apportare tutte le modifiche che si vogliono; due comandi 
permettono di schedulare la rimozione o l'aggiunta di file al repositorio:
\small
\begin{verbatim}
cvs add file1.c
cvs remove file2.c
\end{verbatim}
\normalsize
ma niente viene modificato nel repositorio fintanto che non viene dato il 
comando {\tt commit}: 
\small
\begin{verbatim}
cvs commit [file]
\end{verbatim}
(\`e possibile mandare le modifiche anche per il singolo file). 

Questi comandi comunque non effettuano le modifiche se i file del
repositorio nel frattempo sono stati modificati; in questo caso rilevano le
differenze e restituiscono un {\it merging} delle versioni locale/globale
nella directory di lavoro, che \`e compito del programmatore esaminare per
eliminare eventuali contrasti.

Per esempio viene eseguito un commit su una versione gi\`a modificata da un
altro sul repositorio, il programma segnaler\`a che c'e' un conflitto e
chieder\`a al ``committente'' di intervenire sui files per i quali sono stati
rilevati i conflitti .

Le sezioni di codice in conflitto sono separate come:
\begin{verbatim}
<<<<<<< Makefile
        $(CC) $(CFLAGS) -o pamacq pamacq.c -lm
=======
        $(CC) $(CFLAGS) -o pamacq pamacq.c

>>>>>>> 1.22
\end{verbatim}
nel caso si c'e' stata una modifica sul file (mostrata nella parte superiore)
incompatibile con quella fatta nel repositorio (mostrata nella parte
inferiore). Prima di eseguire un {\it commit} occorre pertanto integrare le
modifiche e risalvare il file; a questo punto il {\it commit} diventa
possibile.

\subsection{Comandi utili}

Ulteriori comandi utili per controllare sono:

\begin{itemize}
\item {\tt cvs update} \\
scarica le eventuali modifiche dei file del repositorio e le applica ai file 
nella directory corrente. In caso di conflitti con modifiche locali effettua un
merging con le caratteristiche esposte in precedenza.

\item {\tt cvs status} \\
compara i file nella directory locale con quelli del repositorio e stampa a 
schermo le informazioni di stato di ciascuno di essi:
\begin{itemize}
\item {\tt Locally Modified} il file \`e stato modificato localmente
\item {\tt Locally Added} il file \`e stato aggiunto localmente
\item {\tt Up to date} il file \`e identico 
\item {\tt Needs Patch} il file e' cambiato sul repositorio (va updatato)
\item {\tt Needs Merge} il file e' cambiato sul repositorio e localmente, le
  differenze vanno riunite prima del commit, in genere basta un {\tt cvs
    update}, ma in caso di conflitti questi vanno sanati.

\end{itemize}

\item {\tt cvs log} \\
legge il log del modulo corrente; in questo modo si hanno le informazioni 
sullo stato del progetto all'interno del repositorio, per ciascun file \`e
vengono mostrati informazioni generali su:
\begin{itemize}
\item release attuale
\item presenza di eventuali ramificazioni
\item lista di etichette simboliche
\item i messaggi di commento salvati ad ogni {\it commit}
\end{itemize}

\item {\tt cvs rtag Etichetta modulo} \\
permette di associare una etichetta alla corrente versione dei file nel 
progetto cos\`\i\ come sono nel repositorio; in modo da poter ritornare a 
quello stato del software con il comando {\tt cvs checkout -rEtichetta module}.

\end{itemize}

\end{document}


