Dynamo-projektin 1. koodin katselmointi

Aika: 8.11.2007 9:33-10:53
Paikka: Jyväskylän yliopisto, AgC223.1
Laadittu 8.11.2007

Läsnä:

Tilaaja:

• Riku Ahonen
• Olli Alanen

• Tero Hätinen
• Joni Purojärvi
• Antti Pyykkönen

• Juha Huikari
• Jukka-Pekka Santanen

Katselmointi

Ryhmä oli lähettänyt lähdekoodin sekä tehdyt muutokset esittävän diff-tiedoston jo edellisellä viikolla projektiorganisaation sähköpostilistalle. Näin kaikilla oli mahdollisuus tutustua koodiin ja tehtyihin muutoksiin jo etukäteen.

Katselmoinnissa Purojärvi esitteli oleellisia kohtia lähdekoodista ja ryhmän siihen tekemistä muutoksista. Katselmoinnin aikana keskustelu oli vapaata. Tilaajan edustajat ja ohjaajat kertoivatkin runsaasti omia mielipiteitään ja parannusehdotuksia.

Huomioita ja parannusehdotuksia

Katselmoinnin aikana tuli esiin seuraavat huomiot ja parannusehdotukset:

• Santanen ehdotti, että lähdekooditiedoston alussa olevat kommentit tulisi järjestää uudestaan. Aluksi tulisi olla maininta Dynamicsista, sitten UDHCP:stä ja viimeisenä Dynamo-ryhmästä ja sen tekemistä muutoksista. Lisäksi Dynamo-ryhmän jäsenten nimet tulisi mainita.
• Lähdekoodiin lisättyjen aliohjelmien alkuun tulee lisätä merkintä, kenen tekemä ko. aliohjelma on. Esimerkiksi: /* DYNAMO: ... */. Lisäksi aliohjelman käyttämät parametrit tulee kommentoida.
• Purojärvi tiedusteli, tulisiko käytettävän verkkosovittimen määritys olla kirjoitettuna asetustiedostoon nykyisen kovakoodauksen sijaan. Huikari lupautui auttamaan asiassa.
• Liian pitkät rivit tulee katkaista Santasen ohjeistuksen mukaisesti.
• Santanen huomautti, että käytettävät vakiot tulisi määritellä erikseen. Esimerkiksi maxmobiles==20;
• malloc()-funktiolla varatut muistialueet tulisi vapauttaa free()-funktiolla Alasen ohjeiden mukaisesti.
• Purojärvi totesi, että release-paketti ei lähde liikkeelle, vaikka koodin mukaan sen pitäisi toimia. Tämä toiminto ei ole standardin mukaan välttämätön, mutta olisi kuitenkin hyvä saada toimimaan.
• Liput, joissa kerrotaan mitä laitteelle tulisi tehdä (0 = register, 1 = renew, 2 = deregister), tulisi muuttaa Santasen ehdotuksen mukaisesti muuttujiksi.
• Santanen huomautti, että kaikkien muuttujien nimet, log-tulostukset ja kommentit tulisi olla suunnitelmien mukaisesti englanniksi. Muuttujien nimien tulisi olla riittävän kuvaavia. Myös kommenttien oikeinkirjoitukseen tulee kiinnittää huomiota.
• Säikeiden luonti tulee korjata. Lisäksi tulee tarkastaa debugilla, mitä muuttujia säikeissä käsitellään, jotta ne voidaan lukita.

Katselmoinnin aikana tuli esiin seuraavat kehitysideat, joita tuskin tullaan toteuttamaan projektin aikana, mutta tullaan dokumentoimaan jatkokehitysideoihin.

• Santanen ehdotti, että isot lähdekooditiedostot pilkottaisiin pienempiin osiin.
• Santanen ehdotti, että sovellukseen voisi lisätä option, joka määrittää käytetäänkö alkuperäistä vai muokattua versiota Dynamicsista.
• Alanen mainitsi, että SPI-tarkastuksen voisi muuttaa asetustiedostosta luettavaksi realmin tarkastukseksi.

Santanen antoi ryhmälle tulostetun version lähdekooditiedostosta, johon hän oli lisännyt omia huomioitaan. Suurin osa näistä huomoista tuli esille myös katselmointitilaisuuden aikana.

Seuraava katselmointi

Seuraavan katselmoinnin ajankohta päätetään seuraavan viikkopalaverin yhteydessä.