NB: Het origineel is recenter dan de vertaling.

Debian Documentatie Project CVS

Het Debian Documentatie Project bewaart zijn webpagina's en veel van de handleidingteksten op de Debian CVS-server op cvs.debian.org.

Iedereen kan de broncode afhalen van de CVS-server. Alleen leden van het Debian Documentatie Project kunnen bestanden bijwerken.

Toegang tot de broncode in CVS

U kunt een viewCVS-interface gebruiken om toegang te hebben tot de individuele bestanden op het web en hun wijzigingen zien op http://cvs.debian.org/?cvsroot=debian-doc.

Om een volledige handleiding af te halen, is rechtstreekse toegang tot de CVS-server vaak een betere optie. Daarvoor hebt u het cvs-package nodig op uw eigen machine.

Anoniem (alleen-lezen) verbinden met de CVS-server

Geef dit commando om te verbinden:

cvs -d :pserver:anonymous@cvs.debian.org:/cvs/debian-doc login

en druk op enter wanneer u om een wachtwoord wordt gevraagd.

U kunt nu normale CVS-commando's (zie de CVS-infopagina's) gebruiken om bestanden af te halen, maar u kunt ze niet committen.

Om de bestanden voor de eerste keer af te halen, maakt u eerst een map aan om alles in op te slaan en ga in de map staan. Er zullen twee mappen CVS en ddp aangemaakt worden in deze map.

Gebruik dit commando om alle bestanden af te halen:

cvs -d :pserver:anonymous@cvs.debian.org:/cvs/debian-doc -z3 checkout ddp/manuals.sgml

Dit zal recursief de mappen aanmaken en ze opvullen.

Om uw lokale kopie bij te werken met wijzigingen gemaakt door anderen, ga in de ddp/manuals.sgml-map en voer dit commando uit:

cvs -z3 update -d -P

Wanneer u een CVS-verbinding wilt afsluiten, gebruikt u dit commando:

cvs logout

Verbinden met de CVS-server, met schrijfprivileges

Alvorens met deze methode te verbinden met de CVS-server, moeten u eerst schrijfrechten verleend zijn. Lees hoe u een aanvraag doet voor de schrijfrechten.

Geef dit commando om te verbinden:

cvs -d :pserver:userid@cvs.debian.org:/cvs/debian-doc login

en geef het wachtwoord dat u hebt onderhandeld met de documentatie-coördinator. Vervang userid in bovenstaand commando met uw eigen gebruikersnaam op de CVS-wachtwoordserver. Dit is niet noodzakelijk dezelfde loginnaam als voor cvs.debian.org, als u er één heeft.

U kan dan de normale CVS-commando's (zie de CVS-infopagina's) gebruiken om bestanden af te halen en te committen.

Om de bestanden voor de eerste keer af te halen, maakt u eerst een map aan om alles in op te slaan en ga in de map staan. Er zullen twee mappen CVS en ddp aangemaakt worden in deze map.

Gebruik dit commando om alle bestanden af te halen:

cvs -d :pserver:userid@cvs.debian.org:/cvs/debian-doc -z3 checkout ddp/manuals.sgml

Dit zal recursief de mappen aanmaken en ze opvullen.

Om uw lokale kopie bij te werken met wijzigingen gemaakt door anderen, ga in de ddp/manuals.sgml-map en voer dit commando uit:

cvs -z3 update -d -P

Wanneer u een CVS-verbinding wilt afsluiten, gebruikt u dit commando:

cvs logout

Verbinden met de CVS-server, met schrijftoegang, gebruikmakend van SSH

Deze methode is enkel toegankelijk voor geregistreerde Debian-ontwikkelaars en wordt geprefereerd over de bovenstaande pserver. Als u recent een geregistreerde Debian-ontwikkelaar bent geworden, verwittig dan de documentatie-coördinator om uw pserver-account te verwijderen.

Om met ssh te verbinden, moet u eerst CVS duidelijk maken dit te gebruiken:

export CVS_RSH=ssh

Maakt dan een map aan om alles in op te slaan en ga in de map staan. Geef dan dit commando:

cvs -d :ext:userid@cvs.debian.org:/cvs/debian-doc -z3 checkout module

Vervang in bovenstaand commando userid met uw eigen gebruikersnaam op de CVS-server. Dit is dezelfde loginnaam als die op alle Debian-machines. Vervang module met de naam van de module die u wenst af te halen, meestal is dat ddp/manuals.sgml. U wordt dan om een wachtwoord gevraagd voor de CVS-server. Verwar dit niet met uw eigen machine.

Er zullen twee mappen, CVS en ddp, aangemaakt worden in deze map. CVS zal recursief alle modules (v.b. mappen) aanmaken die u gevraagd heeft en ze opvullen met bestanden.

U kunt dan normale CVS-commando's (zie de CVS-infopagina's) gebruiken om bestanden af te halen en te 'committen'.

Om uw lokale kopie bij te werken met wijzigingen gemaakt door anderen, ga in de ddp/manuals.sgml-map en voer dit commando uit:

cvs -z3 update -d -P

Schrijfrechten bekomen

Iedereen die wil helpen bij het schrijven van handleidingen kan schrijfrechten bekomen. We vragen meestal dat u eerst een aantal bruikbare patches hebt doorgestuurd.

Stuur een aanvraag naar de Debian documentatielijst om schrijfrechten aan te vragen. Leg uit waarvoor u schrijfrechten nodig hebt. De Documentatie Coördinator of een relevant lid van het Debian Documentatie Team moet uw aanvraag goedkeuren alvorens u schrijfrechten krijgt. Eens ze uw aanvraag hebben goedgekeurd, vraagt u ze een (ondertekende) aanvraag te sturen naar debian-admin.

Als u een Debian-ontwikkelaar bent, dan zult u eens de aanvraag is goedgekeurd, worden toegevoegd aan de cvs_doc-groep op cvs.debian.org en u zult dan de CVS kunnen bijwerken.

Als u geen Debian-ontwikkelaar bent, dan zult u eens de aanvraag is goedgekeurd, een loginnaam en wachtwoord moeten kiezen. De loginnaam moet verschillend zijn van bestaande Debian-accounts (test dit met db.debian.org). Het wachtwoord mag niet onversleuteld worden verstuurd, ookal stuurt cvs dit onversleuteld over het netwerk.

U kunt makepasswd gebruiken om een wachtwoord aan te maken, installeer het pakket en voer het volgende uit:

$ echo "GEHEIM" |makepasswd --clearfrom=- --crypt

Een andere manier om een wachtwoord eenvoudig te versleutelen is met de volgende regel Perl, wetende dat Perl al geïnstalleerd is op uw Debian GNU/Linux-machine voert u het volgende uit:

$ perl -e "printf \"%s\n\", crypt ("GEHEIM", join ('', ('.', '/', 0..9, 'A'.. 'Z', 'a'..'z')[rand (64), rand (64)]))"

Stuur het resultaat, samen met de accountnaam van uw voorkeur naar Martin Schulze. Versleutel de hele e-mail met zijn GnuPG-sleutel.

Voor meer informatie leest u zijn notities over de procedure.


Organisatie van bestanden

Deze figuur toont de structuur van de CVS-mappenstructuur:

DDP CVS directory tree

Merk op dat de DDP-website gelokaliseerd is de webwml-module van de Debian CVS repository, om geïntegreerd te zijn met de rest van de Debian-webpagina's.


Automatisch bijwerkingsmechanisme

De gepubliceerde webpagina's van de handleidingstekst worden door een cronjob gegenereerd op www-master.debian.org elke dag een beetje na 15:39 PST.

Het script doet een cvs update -d -P, en dan make -C manuals.sgml clean publish, beide in de ddp-map.

De makefile is ingesteld om elke submap (die beheerde documentatie bevat) opnieuw op te bouwen en om de bestanden van elke submap te instaleren in de doc/manuals/-submap van de website. De submap makefiles is afgeleid van ddp/manuals.sgml/standard.makefile.

De documentatiebestanden gegenereerd door het bijwerkingsscript kunnen gevonden worden op http://www.debian.org/doc/manuals/.

De logboekbestanden gegenereerd door het bijwerkingsscript kunnen gevonden worden op http://www-master.debian.org/build-logs/ddp/.