Changeset 28270


Ignore:
Timestamp:
Aug 27, 2007, 4:58:26 AM (13 years ago)
Author:
jmpp@…
Message:

Provide some explanatory comments on what the script is about and how to run it.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/base/portmgr/PortIndex2MySQL.tcl

    r28262 r28270  
    3737# POSSIBILITY OF SUCH DAMAGE.
    3838
     39#####
     40# The PortIndex2MySQL script populates a database with key information extracted
     41# from the Portfiles in the ports tree pointed to by the sources.conf file in a
     42# MacPorts installation, found by loading its macports1.0 tcl package and initializing
     43# it with 'mportinit' below. Main use of the resulting database is providing live
     44# information to the ports.php page, a client tailored to poll it. For this very reason,
     45# information fed to the database always has to be kept up to date in order to remain
     46# meaningful, which is accomplished simply by calling 'macports::selfupdate' (which
     47# updates the ports tree in use) and by installing the script on cron/launchd to be run
     48# on a timely schedule (not any more frequent than the run of the mprsyncup script on
     49# the MacPorts server, which is every half hour).
     50#
     51# Remaining requirement to successfully run this script is performing the necessary
     52# MySQL admin tasks to create the database in the first place and the MySQL user that
     53# will be given enough privileges to alter it. Values in the database related variables
     54# provided below have to be adapted accordingly to match the chosen setup.
     55#####
     56
    3957
    4058# Error messages reciepient.
Note: See TracChangeset for help on using the changeset viewer.