Debian-dokumentointiprojekti (DDP) ja SVN

Debianin dokumentointiprojekti säilyttää www-sivustonsa ja valtaosan käyttöoppaiden teksteistä Debianin Subversion-palvelimella osoitteessa svn.debian.org. svn.debian.org on osa alioth.debian.org:n Gforge-asennusta. Aliothin dokumentointi kertoo lisää palvelun toiminnasta.

Kuka tahansa voi imuroida lähdekoodit SVN-palvelimelta. Ainoastaan Debian-dokumentointiprojektin jäsenet voivat päivittää näitä tiedostoja.

Pääsy SVN-palvelimella olevaan lähdekoodiin

Voit käyttää osoitteessa http://anonscm.debian.org/viewvc/ddp/manuals/trunk/ olevaa selainliittymää päästäksesi käsiksi yksittäisiin tiedostoihin ja nähdäksesi niihin tehdyt muutokset.

Suora pääsy SVN-palvelimelle on usein parempi vaihtoehto kokonaisen käyttöoppaan imurointiin. Tarvitset subversion-paketin koneellesi.

Tunnukseton yhteys (vain lukuoikeus) SVN-palvelimelle

Käytä tätä komentoa imuroidaksesi kaikki tiedostot:

svn co svn://svn.debian.org/ddp/manuals/trunk manuals

Tämä luo hakemistot rekursiivisesti ja siirtää tiedostot niihin.

Päivittääksesi paikallisen kopiosi muiden tekemillä muutoksilla, siirry manuals-hakemistoon ja suorita komento:

svn export --force svn://svn.debian.org/svn/ddp/manuals

Yhteydenotto SVN-palvelimelle päivitysoikeuksilla (svn)

Ennen kuin otat yhteyden SVN-palvelimelle tällä menetelmällä sinulla täytyy olla kirjoitusoikeus sinne. Lue ensin kuinka hankitaan päivitysoikeudet.

Käytä tätä komentoa imuroidaksesi kaikki tiedostot:

svn co svn+ssh://svn.debian.org/svn/ddp/manuals/trunk manuals

Tämä luo hakemistot rekursiivisesti ja siirtää tiedostot niihin.

Päivittääksesi paikallisen kopiosi muiden tekemillä muutoksilla, siirry manuals-hakemistoon ja suorita komento:

svn update

Yhteydenotto SVN-palvelimelle päivitysoikeuksilla (git-svn)

Ennen kuin käytät SVN-palvelinta tällä tavalla, sinulla täytyy ensin olla myönnettynä kirjoitusoikeudet. Ole hyvä ja lue ensin kuinka pyydät päivitysoikeuksia.

Käytä tätä komentoa lataamaan kaikki tiedostot:

git svn clone -s -rHEAD svn+ssh://svn.debian.org/svn/ddp/manuals manuals

Tämä luo hakemistot sisältöineen rekursiivisesti sekä luo myös paikallisen git-varaston ilman vanhaa historiatietoa ja jolla voi seurata alioth-SVN-palvelinta.

Päivittääksesi paikalliseen kopioon kaikki muiden tekemät muutokset, siirry hakemistoon manuals ja suorita komento:

git svn rebase

Päivitysoikeuksien hankkiminen

Päivitysoikeudet saa jokainen joka haluaa osallistua käyttöoppaiden kirjoittamiseen. Yleensä vaadimme, että olet lähettänyt ensin muutamia hyödyllisiä korjauksia.

Jotta saat päivitysoikeudet, lähetä pyyntö Debian documentation -postilistalle. Selvitä miksi tarvitset käyttäjätunnuksen. Mainitse pyynnössä Alioth-käyttäjätunnuksesi. Kun pyyntösi on hyväksytty, olet osa ddp-projektia (ja Unix-käyttäjäryhmää) Alioth-palvelimella.

Automaattinen päivitysmekanismi

Käyttöoppaasta julkaistut www-sivut tuotetaan www-master.debian.org-palvelimen joka neljäs tunti tapahtuvan www-sivuston uudelleenkäännöksen yhteydessä.

Skripti suorittaa komennon svn update, ja sen jälkeen make -C trunk publish.

Makefile on asetettu kääntämään jokainen alihakemisto uudelleen (jotka sisältävät ylläpidettävän dokumentaation), ja asentamaan tiedostot jokaisesta alihakemistosta www-sivuston doc/manuals/-alihakemistoon. Alihakemistojen makefile-tiedostot polveutuvat manuals/standard.makefile-tiedostosta.

Päivitysskriptin tekemät dokumentit löytyvät osoitteesta http://www.debian.org/doc/manuals/.

Päivitysskriptin tekemät lokitiedostot löytyvät osoitteesta http://www-master.debian.org/build-logs/ddp/

Huomaa, että tämä prosessi luo /doc/manuals/-hakemiston uudelleen. /doc/-hakemiston sisältö luodaan joko webwml- tai muiden skriptien kautta, esim. sellaisten, jotka hakevat tietyt manuaalit pakettien sisältä.