Setup guide til Visual C++, WinCvs og Doxygen
Sidst opdateret d. 21/2 - 2002 - af Casper Thomsen (raist@cs.auc.dk)
WinCvs
| Først installer SSH hvilket kan gøres fra
/group/arthur/cvstools. Derefter ændres PATH env. til at indeholde stien
til SSH (eg. C:\Program Files\SSH) og oprette en HOME env. med samme sti.
Test om det virker ved at starte en dos prompt og skriv:
"ssh2 -l <brugernavn> dumbo.ima.auc.dk". Ved at gøre det oprettes den nøgle som skal ligge i "RSA identity" stien af WinCvs og den ligger nu i: "C:\Documents and Settings\<bruger>\Application Data\SSH\HostKeys" Filen hedder noget i retning af "key_22_dumbo.ima.auc.dk.pub". Start WinCvs op og gå ind under "Admin->Preferences". Under "General" fane bladet sættes CVSROOT til: "<brugernavnpåUNIXserveren>@dumbo:/group/arthur/cvsroot" og "Authentication" aendres til "SSH". "RSA identity" stien skal linke til ovennævnte nøgle "key_22_dumbo.ima.auc.dk.pub" fra SSH. Under "Globals" fane bladet skal flg. være
"checked": Under "Ports" fane bladet skal de to nederste være "checked". Under "alternate server name" specificeres den fulde sti til cvs path på dumbo, som er "/coll/vrml/bin/cvs". Den sidste "alternate rsh name" skal ændres til "ssh2". De 3 andre skal ikke indeholde noget. Under "WinCvs" fane bladet skal "HOME folder" indeholde stien til SSH nøjagtigt som HOME env. nævnt ovenfor. For at lave en checkout, gå ind under menuen til højre for "admin" og vælg "checkout module". Under "Checkout settings" fane bladet "module name and path on server" skal være en af de moduler som ligger i CVSROOT. I vores tilfælde dvs. enten "cv-mockup" eller "smalltool" som det ser ud nu. Bemærk dette ændres nok med tid og kan betragtes som eksempler kun. "Local folder to checkout to" sættes til stien til der hvor du gerne vil have din lokale kopi af cvs modulet til at ligge så du kan arbejde med det. De 3 checkboxes forblives "unckecked". Under "globals" skal fane bladet sættes nøjagtigt som i "preferences" nævnt ovenfor. Klik "OK" og checkout skulle begynde. Hvis "CVS exited normally with code 0" er det gået godt. Hvis det var "code 1" gik noget galt. Gå tilbage og tjek om du har glemt noget, ellers mail mig. Bemærk at alle ubeskrevne fane bladet skal der ikke ændres noget i. Considering readers of this manual, extensions will continue in english from now on. To use WinCvs without typing password, you need ssh (not ssh2). You can download ssh here. Put the ssh .exe files in yor PATH, open a dos prompt and type: ssh-keygen -C "" Specify a filename you want to store the key in. When it asks for a
passphrase press enter for empty passphrase (for additional security write
a passphrase, this makes no difference for WinCVS to work). When done ssh
has made 2 keys for you: This is your private and public keys respectively. Put the private key (identity) in a directory called $HOME\.ssh (if it does not exist create it from a dos prompt with 'mkdir .ssh'). The public key goes to the server to which you want to log on (dumbo.ima.auc.dk). Use secure copy, ftp or whatever you want to put this file in '~/.ssh'. Now append it to a file called authorized_keys using 'cat identity.pub >> authorized_keys' (if file does not exist it will be created). Now test that configuration works by typing the following in the dos
prompt: If configuration is correctly set up you do not have to supply a password now. In WinCVS enter 'admin->preferences' again. Under the General leaf check the 'RSA identity' checkbox and provide the path to the private key ('identity'). Now you should never have to supply a password again. Considering security issues it is advised that the private key is stored somewhere that only you have access to it. Failure to do so can result in other people having direct access to your account on dumbo without having to supply a password. This is a security risk that can easily be avoided by placing the private key under 'documents and setting' under your username (make sure you change to $HOME variable accordingly). |
| Cvs står for Concurrent Versions System.
En fuld manuel i pdf format kan downloades her. De mest fundementale ting der er brug for er som foelger:
Fordelen ved CVS er at du kan gaa en eller flere versioner tilbage i en fil hvis du fortryder dine rettelser senere i forloebet. Fremgangsmaaden for det er flg:
|
| WinCVS kan rimeligt let integreres i Visual C++. Det
eneste det kræver er blot at du downloader cvsln_dll.zip og
pakker den ud til VisualStudio\Common\MSDev98\AddIns.
Start Visual C++ og gå ind under "tools->Customize->Add-ins and Macro files". Der skulle gerne være en "checkbox" til WinCvs som kan tjekkes. Hvis den ikke er der søg efter dll filen med "browse" fra samme sted. Nu skulle der være en toolbar til WinCvs i VC++. Klik på setting og ændrer opsætningen på første fane blad så stien til din WinCvs er korrekt. Resten er ikke nødvendig at ændre på da vi kun vil bruge en lille del af funktionaliteten i den værktøjslinje, og bruge WinCvs programmets GUI istedet. |
| Værktøjslinjen til WinCvs i VC++ anvendes i praksis kun til at starte og stoppe WinCvs. Resten af funktionaliteten klares fra WinCvs egen GUI. Det er faktisk slet ikke muligt at anvende de andre features, men finder du ud af hvordan må du gerne smide mig en mail på addressen ovenfor. Det anbefales stadig at bruge WinCvs egen GUI da det betyder mere kontrol og færre uheld. GUI'en giver bedre overblik over hvad du f.eks comitter (de filer vises med rødt), og så slipper vi for fejl commits. |
| På samme måde som med WinCvs kan Doxygen integreres i
VC++. For at gøre det skal filen "doxbar.dll" ligge i
"add-ins" i VC++. Filen kan findes på
"/group/arthur/cvstools".
Lav en ny tom fil "C:\temp\rundox.bat" IKKE "rundox.bat.txt". Start VC++ og gå ind under "tools->customize". Under "Tools" fane bladet tilføj en ny entry i "menu contents" ved navn "Doxygen". Klik på den og tilføj stien til "rundox.bat" i "Command" feltet. "Initial directory" feltet skal indeholde "$(CurDir)". Når det er gjort gå ud af menuen igen og klik på "tools" menuen igen. Tæl alle tools ned til "Doxygen" og husk det nummer den har i rækkefølgen. Når værktøjslinjen er lagt ind i VC++ klik på den midterste knap der
gerne skulle være "configure". Felterne udfyldes som følger: Resten af felterne er unødvendige for anvendelsen af doxygen fra VC++. Den er nu klar til at køre ved at klikke på venstre knap i værktøjslinjen. Configurations filen er sat op til at ligge output af doxygen i "E:\Doxygen". Hvis dir'et ikke eksisterer laver den det selv. Dette er nemt at ændre (hvilket det skal, vi skal finde et mere passende sted at ligge det) ved at åbne "DoxyConf" med WordPad og ændre stien de 2 steder den er nævnt i filen. |
| Flg. er en kort beskrivelse af de mest basale kommandoer
for at kunne bruge doxygen på en god og nem måde.
Eks. /*! \class Test
\brief kort beskrivelse
Detaljeret beskrivelse
*/
Der findes mange strukturelle kommandoer i doxygen som \class og \brief. Bl.a.
Et forslag til en god header som kan inkluderes i alle .cpp filer ville
være det flg. eks. /*! \class Test
\brief Kort beskrivelse
\author Casper Thomsen
\author evt. flere ..
\bug Beskrivelse af buggen
\bug Måske en prototype med mange bugs?
\warning Advar brugeren om evt. fælder
*/
|
| Opdateres jævnligt med eventuelle spørgsmål rettet mod opsætningsproblemer. |