(H) Gitin ignore-tiedoston tekeminen¶

Tavoitteet: Opin asettamaan .gitignore-tiedoston repositoriooni.

Ohjeita: Toteuta henkilökohtaiseen Git-keskustietovarastoosi .gitignore-tiedosto, jonka avulla kaikki Qt Creatorin muodostamat build-hakemistot sekä .pro.user-päätteiset tiedostot jäävät pois versionhallinnasta.

Attention

Tämän tehtävän tekeminen on erittäinen suositeltavaa, koska se helpottaa työskentelyäsi tällä kurssilla. Aivan välttämätöntä se ei ole, eikä sitä tarvitse tehdä juuri nyt. Voit palata tähän tehtävään myöhemmin, kun huomaat .gitignore-tiedoston tarpeelliseksi. (Tehtävän deadline on vasta myöhään keväällä.)

Taustaa¶

On olemassa tiedostoja, joita ei haluta tallentaa versionhallintaan. Esimerkiksi kaikki Qt Creatorin build-kansiosta löytyvät tiedostot pystyy luomaan uudelleen suorittamalla buildin Qt Creatorissa, kun vain lähdekooditiedosto ja projektitiedosto on tallella, joten miksi lisäisimme build-kansion sisältöä Gittiin.

Emme halua lisätä näitä tiedostoja vahingossa esimerkiksi git add --all -komennolla tai katsoa edes kyseisiä tiedostoja git status -komennon yhteydessä. Asiassa auttaa .gitignore -niminen tiedosto. Kyseessä on tavallinen tekstitiedosto, johon on lueteltu kaikki versionhallinnan ulkopuolelle jäävät polut ja tiedostot. Voit luoda tällaisen tiedoston millä tahansa editorilla. (Esimerkiksi Linux-etätyöpöydältä löytyy editori: Applications -> Accessories -> Text Editor.)

Tässä kohdassa voimme muistella uudestaan esimerkiksi villikorttien käyttöä ja mitä tarkoittavat esimerkiksi *.txt tai *~. (Jos et muista, mitä nämä tarkoittavat, voit tarkistaa asian materiaalin lopusta löytyvästä luvusta “Itseopiskelu: Gitin käyttö komentoriviltä” ja sieltä kohta “Komentorivioperaatioita”.)

Esimerkiksi .pro.user-päätteiset tiedostot sisältävät Qt-projektin paikallisia asetuksia, joita ei yleensä haluta tallentaa Gitiin. Kun lisäät tiedostoon .gitignore rivin:

*.pro.user

Git jättää jatkossa kaikki .pro.user-päätteiset tiedostot huomioimatta, poislukien sellaiset, jotka on jo lisätty aiempaan committiin. (Jos haluat päästä aiemmin lisätyistä tiedostoista eroon, sinun pitää käydä poistamassa ne git rm -komennon avulla.)

Tehtävän aloitus¶

Luo repositoriosi juureen kaksi uutta tekstitiedostoa, .gitignore ja testi.pro.user komennolla:

touch .gitignore testi.pro.user

Mitä sanoo komento git status? Avaa .gitignore tekstieditorilla ja lisää sinne rivi *.pro.user. Katso uudestaan, miltä status näyttää.

Tehtävän viimeistely¶

Lisää .gitignore-tiedostoosi myös rivi, joka estää build-hakemistojen tulemisen mukaan versionhallintaan.

Voit varmistella oman gitignoresi toimintaa käyttämällä komentoa git status. Jos lisäät uusia tiedostoja ja status ei näytä niitä “Untracked files:”-osassa, toimii gitignore ainakin kyseisen tiedoston kohdalla.

Vinkkejä tehtävän tekemiseen:

Varmista aluksi, ettei repositoriossasi ole tallentamattomia muutoksia.
Tiedosto .gitignore pitää tehdä repositorion juureen.
Tehtävää tehdessäsi käytä apuna komentoa git status tilan tarkastelemiseen, kuten edellä opastettiin.
Älä missään nimessä vahingossakaan lisää .gitignore-tiedostoon sellaisia tiedostoja, joita sinun pitää palauttaa, esim. .cpp, .hh tai .pro.
Halutessasi voit kirjoittaa .gitignore-tiedostoon myös muita rivejä, joilla voit karsia automaattisesti pois tietyn tyyppisiä tiedostoja.

A+ esittää tässä kohdassa tehtävän palautuslomakkeen.