Enlightenment CVS committal Author : technikolor Project : web Module : e
Dir : web/e Modified Files: README Log Message: Updated the readme with instructions on how to update the site properly. I also dumped my doc generation script into it. Updated the nav bar, updated the news. =================================================================== RCS file: /cvsroot/enlightenment/web/e/README,v retrieving revision 1.5 retrieving revision 1.6 diff -u -3 -r1.5 -r1.6 --- README 22 Jun 2004 20:03:14 -0000 1.5 +++ README 29 Jun 2004 00:32:25 -0000 1.6 @@ -27,5 +27,141 @@ properly, you should always be commiting at least 2 HTML files. -Update: 6/16/04 + +How to actually update the site +------------------------------- + +To actually put the pages on the web, you need to log into the SF shell server. +Once your there, you can change directory to the htdocs base dir and just do +a simple "cvs update" from there, if you add new files, make sure to use +"cvs update -d". Do NOT just simply wipe the directory and do a clean checkout! +I actually alias the htdocs base dir so that I don't have to type it out. Here's +how it works: + [EMAIL PROTECTED] benr]$ ssh -l technikolor shell.sourceforge.net [EMAIL PROTECTED]'s password: + (blah blah) [EMAIL PROTECTED]:~$ alias +alias htdocs='cd /home/groups/e/en/enlightenment/htdocs' <-- thats the directory [EMAIL PROTECTED]:~$ htdocs [EMAIL PROTECTED]:/home/groups/e/en/enlightenment/htdocs$ ls +config CVS data doxy index.crap index.php Makefile pages README s temp [EMAIL PROTECTED]:/home/groups/e/en/enlightenment/htdocs$ cvs update +? doxy +? index.crap + (blah blah) [EMAIL PROTECTED]:/home/groups/e/en/enlightenment/htdocs$ exit + +NOTE: Leave that "doxy" directory alone! (See below) + + +How the E docs are autogenerated nightly +---------------------------------------- + +This is something that currently my user account (technikolor) is responsable for. +I hacked up a shell script that pulls CVS each night freshly and runs a gendoc for each +applicable codbase and then moves the docs to the appropriate place. This is the ONLY +thing that makes me (benr aka technikolor) "special", otherwise everyone can do the same stuff +I can assuming you have E SF dev access. + +The script is below. I run this from cron: [EMAIL PROTECTED]:~$ crontab -l +# DO NOT EDIT THIS FILE - edit the master and reinstall. +# (/tmp/crontab.9901 installed on Mon Mar 8 01:03:02 2004) +# (Cron version -- $Id: README,v 1.6 2004/06/29 00:32:25 technikolor Exp $) +0 0 * * * /home/users/t/te/technikolor/gen_site_docs.sh >&/dev/null + + +The script: +==========================================================================[Script Begin] +#!/bin/bash + +export CVSROOT=":pserver:[EMAIL PROTECTED]:/cvsroot/enlightenment" + + +## First Check Out CVS + +cd +#cvs co e17/libs + +## Now run around creating docs. + +# EVAS +echo "Generating EVAS\n" +rm -rf /home/groups/e/en/enlightenment/htdocs/doxy/evas/* +cd +cvs co e17/libs/evas +cd e17/libs/evas +./gendoc +cd doc/html +cp -a . /home/groups/e/en/enlightenment/htdocs/doxy/evas/ +cd ../latex && make pdf && mv refman.pdf /home/groups/e/en/enlightenment/htdocs/doxy/evas/evas-reference.pdf + +# EET +echo "Generating EET\n" +rm -rf /home/groups/e/en/enlightenment/htdocs/doxy/eet/* +cd +cvs co e17/libs/eet +cd e17/libs/eet +./gendoc +cd doc/html +cp -a . /home/groups/e/en/enlightenment/htdocs/doxy/eet/ +cd ../latex && make pdf && mv refman.pdf /home/groups/e/en/enlightenment/htdocs/doxy/eet/eet-reference.pdf + +# Ecore +echo "Generating Ecore\n" +rm -rf /home/groups/e/en/enlightenment/htdocs/doxy/ecore/* +cd +cvs co e17/libs/ecore +cd e17/libs/ecore +./gendoc +cd doc/html +cp -a . /home/groups/e/en/enlightenment/htdocs/doxy/ecore/ +cd ../latex && make pdf && mv refman.pdf /home/groups/e/en/enlightenment/htdocs/doxy/ecore/ecore-reference.pdf + +# Ecore +echo "Generating Edje\n" +rm -rf /home/groups/e/en/enlightenment/htdocs/doxy/edje/* +cd +cvs co e17/libs/edje +cd e17/libs/edje +./gendoc +cd doc/html +cp -a . /home/groups/e/en/enlightenment/htdocs/doxy/edje/ +cd ../latex && make pdf && mv refman.pdf /home/groups/e/en/enlightenment/htdocs/doxy/edje/edje-reference.pdf + +# Epeg +echo "Generating Epeg\n" +rm -rf /home/groups/e/en/enlightenment/htdocs/doxy/epeg/* +cd +cvs co e17/libs/epeg +cd e17/libs/epeg +./gendoc +cd doc/html +cp -a . /home/groups/e/en/enlightenment/htdocs/doxy/epeg/ +cd ../latex && make pdf && mv refman.pdf /home/groups/e/en/enlightenment/htdocs/doxy/epeg/epeg-reference.pdf + + +# Ewl +echo "Generating Ewl\n" +rm -rf /home/groups/e/en/enlightenment/htdocs/doxy/ewl/* +cd +cvs co e17/libs/ewl +cd e17/libs/ewl +doxygen +cd doc/html +cp -a . /home/groups/e/en/enlightenment/htdocs/doxy/ewl/ +cd ../latex && make pdf && mv refman.pdf /home/groups/e/en/enlightenment/htdocs/doxy/ewl/ewl-reference.pdf + + +######## + +cd +rm -rf e17/ + +echo "\nDone!\n" +==========================================================================[Script End] + + +Last Updated: 6/28/04 by benr (aka: technikolor) ------------------------------------------------------- This SF.Net email sponsored by Black Hat Briefings & Training. Attend Black Hat Briefings & Training, Las Vegas July 24-29 - digital self defense, top technical experts, no vendor pitches, unmatched networking opportunities. Visit www.blackhat.com _______________________________________________ enlightenment-cvs mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs