SubWCRev on Windows-konsoliohjelma, jota voidaan käyttää lukemaan Subversion-työkopion tila ja mahdollisesti suorittamaan avainsanojen korvaus kaavaintiedostossa. Tätä käytetään usein osana ohjelmiston rakennusprosessia keinona kytkeä työkopion tilatieto rakennettavaan ohjelmaan. Tyypillisesti sitä voitaisiin käyttää esim. sisällyttämään versionumero ”Tietoa”-ikkunaan.
SubWCRev lukee työkopion kaikkien tiedostojen Subversion-tilan, ohittaen oletusarvoisesti ulkoiset viittaukset. Se tallettaa korkeimman löydetyn versionumeron ja sen aikaleiman; lisäksi talletetaan tieto siitä, onko työkopiossa paikallisia muutoksia tai useita päivitysversioita. Versionumero, päivitysversioväli ja muutostila tulostuvat konsolille.
SubWCRev.exe -ohjelmaa kutsutaan komentoriviltä tai komentojonosta, ja sitä voidaan ohjata seuraavilla valitsimilla:
SubWCRev WorkingCopyPath [SrcVersionFile DstVersionFile] [-nmdfe]
WorkingCopyPath on polku tarkistettavana olevaan työkopioon. Voit käyttää SubWCRev-komentoa ainoastaan työkopioihin, ei suoraan arkistoon. Polku voi olla absoluuttinen tai suhteessa nykyiseen työhakemistoon.
Jos haluat, että SubWCRev korvaa avainsanat, jotta sellaiset kentät kuten esim. arkistoversio ja paikannin tallettuvat tekstitiedostoon, sinun on annettava kaavaintiedosto SrcVersionFile sekä tulostiedosto DstVersionFile, joka sisältää kaavaimen sisällön laajennettuna.
SubWCRev kykenee ohittamaan halutut tiedostot tai polut. Ohituslausekkeet luetaan tiedostosta, jonka nimi on .subwcrevignore. Tiedosto voidaan lukea annetusta polusta tai työkopion juuresta. Mikäli tiedostoa ei löydy, mitään tiedostoja tai polkuja ei ohiteta. Tiedosto .subwcrevignore voi sisältää useita rivinvaihdolla eroteltuja ohituslausekkeita. Lausekkeet täsmätään arkiston juureen sekä .subwcrevignore -toedpstpm polkuun nähden suhteellisten polkujen kanssa. Esimerkki: Ohittaaksesi kaikki tiedostot TortoiseSVN-projektin doc -kansiosta aseta ohituslausekkeet seuraavasti:
/trunk/doc /trunk/doc/*
Tai, olettaen, että tiedosto .subwcrevignore on päähaaran työkopion juuressa, sama tulos saadaan lausekkeilla
doc doc/*
Ohittaaksesi kaikki kuvat, ohituslausekkeet voidaan määritellä seuraavasti:
*.png *.jpg *.ico *.bmp
Samoin kuin Subversionissa yleensä, ohituslausekkeissa isot ja pienet kirjaimet tarkoittavat eri asioita.
Luodaksesi pisteellä alkavan tiedostonimen Windows-resurssienhallinnassa, anna nimeksi .subwcrevignore.. Huomaa piste lopussa.
On olemassa useita valitsimia, jotka vaikuttava SubWCRev-komennon toimintaan. Jos käytät useampaa kuin yhtä, ne on määritettävä yhtenä ryhmänä, esim. -nm, ei -n -m.
Taulu 6.1. Lista käytettävissä olevista komentorivivalitsimista
| Vaihda | Kuvaus |
|---|---|
| -n | Jos tämä valitsin on annettu, SubWCRev palauttaa arvon ERRORLEVEL 7 jos työkopiossa on paikallisia muutoksia. Tätä voidaan käyttää esim. estämään ohjelman käännös, jos työkopiosta löytyy toimittamattomia muutoksia. |
| -N | Jos tämä valitsin on annettu, SubWCRev palauttaa arvon ERRORLEVEL 11, jos työkopio sisältää versioimattomia tiedostoja, joita ei olla ohitettu. |
| -m | Jos tämä valitsin on annettu, SubWCRev palauttaa arvon ERRORLEVEL 8, jos työkopio sisältää useita versioita. Tätä voidaan käyttää esim. estämään käännös osittain päivitetylle työkopiolle. |
| -d | Jos tämä valitsin on annettu, SubWCRev palauttaa arvon ERRORLEVEL 9, jos kohdetiedosto on jo olemassa. |
| -f | Jos tämä valitsin on annettu, SubWCRev sisällyttää tuloksiin kansioiden viimeksi muutetun version. Oletusarvoisesti vain tiedostot otetaan huomioon versionumeroita haettaessa. |
| -e | Jos tämä valitsin on annettu, SubWCRev tutkii hakemistot, jotka on lisätty komennolla svn:externals, mutta vain, jos ne ovat samasta arkistosta. Oletustoiminta on ohittaa ulkoiset viittaukset. |
| -E | Kuten -e, mutta ohittaa ulkoiset viitteet, joilla on kiinteä versio, mikäli niiden versioväli on pelkästään ominaisuuksissa määritelty versio. Tämä ei siis johda sekaversioihin, |
| -x | Jos tämä valitsin on annettu, SubWCRev näyttää versionumeron heksadesimaalisena. |
| -X | Jos tämä valitsin on annettu, SubWCRev näyttää versionumeron heksadesimaalisena etuliitteen '0X' kanssa. |
| -F | Kun tämä valitsin on annettu, SubWCRev ohittaa kaikki .subwcrevignore-tiedostot ja sisällyttää kaikki muut tiedostot. |
| -q | Jos tämä valitsin on annettu, SubWCRev suorittaa avainsanojen korvaamisen näyttämättä työkopion tilatietoja. |
Onnistuessaan SubWCRev palauttaa arvon nolla. Virheen sattuessa virheviesti kirjoitetaan konsoli-ikkunan stderr-virtaan. Mahdolliset virhekoodit onvat seuraavat:
Taulu 6.2. Luettelo SubWCRev-virhekoodeista
| Virhekoodi | Kuvaus |
|---|---|
| 1 | Muotovirhe. Ainakin yksi komentoriviparametri on väärin. |
| 2 | Komentorivillä annettua tiedostoa tai kansiota ei löydy. |
| 3 | Lähdetiedoston avaus tai kohdetiedoston luonti epäonnistui. |
| 4 | Muistin varaus epäonnistui. Mahdollinen syy voi olla liian suuri lähdetiedosto. |
| 5 | Lähdetiedoston jäsennystä ei voitu tehdä ongelmitta. |
| 6 | SVN-virhe: Subversion raportoi virheen, kun SubWCRev pyysi tietoja työkopiosta. |
| 7 | Työkopiossa on paikallisia muutoksia. Tämä vaatii valitsimen -n käyttöä. |
| 8 | Työkopiossa on useita versioita, Tämä vaatii valitsimen -m käyttöä. |
| 9 | Kohdetiedosto on jo olemassa. Tämä vaatii valitsimen -d käyttöä. |
| 10 | Annettu polku ei ole työkopio tai sen osa. |
| 11 | Työkopiossa on versioimattomia tiedostoja tai kansioita. Tämä vaatii valitsimen -N käyttöä. |