home *** CD-ROM | disk | FTP | other *** search
/ linuxmafia.com 2016 / linuxmafia.com.tar / linuxmafia.com / pub / palmos / pippy-0.6beta-src.tar.gz / pippy-0.6beta-src.tar / pippy-0.6beta-src / docs / TOOLS < prev   
Text File  |  2001-02-23  |  9KB  |  275 lines
  1.  
  2. Pippy - The port of Python to the Palm OS.
  3.  
  4. VERSION: Pippy 0.6beta.
  5.  
  6. Copyright (c) 2001 Endeavors Technology, Inc.
  7. All rights reserved.
  8.  
  9. This document describes how to obtain and install the tools necessary
  10. for building Pippy, Python for the PalmOS.
  11.  
  12.  
  13. TOOL INSTALLATION
  14.  
  15.     IMPORTANT:  This version of Pippy requires a specific version
  16.     of Python in order to perform the builds. See below.
  17.     
  18.     We used RedHat-6.2 for our development, but the tool set will
  19.     generally work for Windows 95 and higher.
  20.  
  21.     Note that under Linux you may have to be root to perform some of the
  22.     installations described below.  See you local System Administrator
  23.     if you have questions.
  24.  
  25. 1. OBTAIN AND INSTALL THE NECESSARY VERSION OF PYTHON (Version 1.5.2+)
  26.  
  27.     For compatibility purposes, this version of Pippy requires Python
  28.     Version 1.5.2+.
  29.     
  30.     A. The source code for this version can be obtained in two ways:
  31.     
  32.     (i). Download the file
  33.         <http://www.endeavors.com/pippy/Python-1.5.2+.tar.gz>
  34.     
  35.     (ii). Checkout from the Python CVS Repository
  36.        Website: <http://python.sourceforge.net/>
  37.        
  38.        How to check it out using CVS under Linux.
  39.        TAG = pre-unicode
  40.        
  41.       
  42.      B. Build and Install Python 1.5.2+
  43.      
  44.         (i). Unpack the distribution file (not required if you checked
  45.         out the files from the CVS repository).
  46.         
  47.         (ii) cd to the directory where you unpacked the Python 1.5.2+ source.
  48.         
  49.         (iii) Read the README file - it describes how to build this 
  50.               version of Python.
  51.         
  52.         
  53.         NOTE: The default installation will put the Python files in
  54.               /usr/local/{bin, lib}.  If there are any other Python 
  55.               Version 1.5.X files in this location, the default installation
  56.               will over write the existing files.  See the Python README.
  57.               
  58.               The Python 1.5.2 rpm under RedHat-6.2 installs python into
  59.               /usr/bin and /usr/lib; so this installation will not be affected.
  60.      
  61.         We recommend running the tests (make test , see the Python
  62.         source README file) to verify your installation.
  63.         
  64.         At this point you should have Python 1.5.2+ installed and working on
  65.         your system.
  66.         
  67.  
  68. 2. OBTAIN THE NECESSARY TOOLS
  69.  
  70. Perform Steps 2.A-C below.
  71.  
  72. 2.A You will need to obtain the prc-tools from only ONE of the following
  73. sources, i.e., do either (i) or (ii):
  74.  
  75.     (i) Obtain the prc-tools from:
  76.          <ftp://ivan.Harhan.ORG/fs2/pub/embedded/palmos>
  77.          prc-tools.0.6.0beta.tar.gz
  78.          prc-tools.0.6.0beta-fixes
  79.          
  80.          NOTE: These files are provided by the Embedded Systems Engineering
  81.          (ESE) group at the IFCTF
  82.  
  83. - OR -
  84.  
  85.     (ii) For Linux only
  86.  
  87.     Download the file:
  88.         <http://www.endeavors.com/pippy/prc-tools-0.6.0-1.i386.rpm>
  89.      
  90.     This file contains:
  91.         prc-tools.0.6.0beta
  92.         prc-tools.0.6.0beta-fixes
  93.         pilrc-2.6 
  94.  
  95.     The rpm installs into <prefix>=/usr/local/palm.  The rpm has been tested only
  96.     using RedHat-6.2, but may work with other releases.
  97.  
  98.  
  99. 2.B Palm OS SDK 3.5 Headers and Libraries
  100.     Go to: <http://www.palmos.com/dev/tech/tools>
  101.     follow the link: Palm OS SDK version 3.5 [it takes you to a CGI License agreement]
  102.     After accepting the agreement you will be on a page with links for Win/Mac
  103.     and Unix SDK software.
  104.     
  105.     Under Unix download the "Palm OS SDK 3.5 Headers and Libraries" file.
  106.     
  107.     Under Windows, download the "Optional Download of Core SDK Components" file.
  108.         This file is required since it supplies the file: NetSocket.c which
  109.         is needed later (see below).
  110.     
  111. 2.C Palm OS Examples
  112.     Go to: <http://www.palmos.com/dev/tech/tools>
  113.     follow the link: Palm OS SDK version 3.5 [takes you to a CGI License agreement]
  114.     After accepting the agreement you will be on a page with links for Win/Mac
  115.     and Unix SDK software.
  116.     
  117.     Under Unix download the "Examples" file.
  118.     
  119.     
  120. 3. INSTALL THE NECESSARY TOOLS
  121.  
  122. 3.A Install prc-tools
  123.         Using either the rpm or other files you downloaded as described
  124.         above in (1.A) install the prc-tools. To install using the rpm:
  125.         
  126.         rpm -Uvh prc-tools-0.6.0-1.i386.rpm
  127.         
  128.        The rpm file will install into the following path:
  129.            <prefix>=/usr/local/palm 
  130.  
  131.  
  132. 3.B Install the Palm OS SDK 3.5 Header/Library Files
  133.  
  134.    (i)  Unpack the distributions you downloaded in Step (2.B) above.
  135.         The SDK 3.5 file for Unix is distributed as: sdk35.tar.gz
  136.         
  137.         Change to the directory where you want to install these files
  138.         (referenced as <Palm SDK path>) and execute the command:
  139.         
  140.         gzip -dc sdk35.tar.gz | tar -xvf -
  141.     
  142.     
  143.     (ii) Move some of the files installed in this last step (3.B.i) to a
  144.          specific target location.  Perform the following steps to create
  145.          this location:
  146.         
  147.             cd /usr/local/palm
  148.             mkdir com
  149.             cd com
  150.             mkdir sdk
  151.             cd sdk
  152.             mkdir include
  153.             
  154.             You now have the path: /usr/local/palm/com/sdk/include
  155.     
  156.     (iii) Next copy some of the Palm SDK files to the proper location.
  157.     
  158.           cd <Palm SDK path>/Palm OS 3.5 Support/Incs
  159.           
  160.           At this point you are in a subdirectory of the Palm SDK directory.
  161.           This subdirectory contains other subdirectories and several files.
  162.           You want to copy all of the files and subdirectories (including their files)
  163.           from this point down to a target location
  164.           <prefix>/com/sdk/include/; we used the following command to copy these
  165.           files:
  166.            
  167.           cp -vR --target-directory=/usr/local/palm/com/sdk/include/ *
  168.  
  169.           If successful the resulting path to the directory "Core" should be
  170.           <prefix>/com/sdk/include/Core
  171.     
  172.  
  173. 3.C Install the Palm Examples files
  174.     
  175.     Unpack the Examples distribution you downloaded in Step (2.C) above.
  176.     You can do this in any location, however, we choose to do this in
  177.     the same subdirectory used in Step 3.B.i: <Palm SDK path>.  
  178.     
  179.     Here are the commands we used, assuming the Examples distribution file
  180.     is in ./xfer/pippy-tools/ off your home directory:
  181.     
  182.         cd <Palm SDK path>
  183.         gzip -dc ../xfer/pippy_tools/sdk35-examples.tar.gz |tar -xvf -
  184.  
  185.     [Note: The files provided by the Examples distribution are used when you
  186.            want to include your own Python modules in your build of Pippy.]
  187.  
  188. 3.D Update the libNetSocket.a file
  189.    
  190.    (i)   Extract the file: NetSocket.c from the Windows distribution
  191.          file you downloaded in Step 2.B.
  192.          
  193.    (ii)  Recompile this file and create a new library: libNetSocket.a,
  194.          using the commands:
  195.     
  196.         m68k-palmos-coff-gcc -c NetSocket.c
  197.         m68k-palmos-coff-ar -r libNetSocket.a NetSocket.o
  198.  
  199.     [NOTE: The m68k-palmos-coff-* applications are in /usr/local/palm/bin ]
  200.  
  201.     (iii) Copy the following two files:
  202.     
  203.             GCC Libraries/m68k-palmos-coff/libPalmOSGlue.a 
  204.             libNetSocket.a 
  205.             
  206.             into 
  207.             
  208.             <prefix>/m68k-palmos-coff/lib
  209.  
  210.  
  211. CONGRATULATIONS!
  212. YOUR TOOLSET IS NOW READY FOR BUILDING PYTHON ON THE PALMOS.
  213.  
  214.  
  215. KNOWN PROBLEMS
  216.  
  217. The libNetSocket.a file supplied with the Palm SDK has given us problems
  218. in the past. We therefore decided to build a clean version.
  219. See Step 3.D above.
  220.  
  221.  
  222. WHY THIS TOOLSET?
  223.  
  224. There are several tool sets available for developing applications for
  225. the Palm. Palm supports prc-tools-2.0 (derived from prc-tools-0.5) and
  226. Code Warrior (Windows only).  We chose prc-tools.0.6.0beta, a revision
  227. of prc-tools based on prc-tools-0.5, for a variety of reasons.  It
  228. provides GLib shared libraries with multiple-segment support, seamless
  229. access to globals within each segment and function pointer support. 
  230. None of the other development tool sets currently provide all of these
  231. features.
  232.  
  233. Our original intention when we started to port Python to the PalmOS was
  234. to stay in sync with the Python CVS tree.  At the time this version of
  235. the port was started, the latest snapshot of the Python CVS repository
  236. was post-string methods and pre-unicode. This snapshot of the repository
  237. was referred to informally by the development community as Python-1.5.2+
  238. (TAG = pre-unicode).  Between 1.5.2+ and 1.6, unicode was the most
  239. obvious addition.  There were also a few minor features added to the
  240. language. At this time we made specific changes to 1.5.2+ standard
  241. library modules, therefore, the 1.5.2+ and 1.6 libraries are
  242. incompatible, and only the 1.5.2+ library is compatible with the
  243. Pippy-0.6beta release.
  244.  
  245.  
  246. LINKS AND CONTACT INFORMATION
  247.  
  248.     Pippy Development Home
  249.     <http://www.endeavors.com/pippy.html>
  250.  
  251.     Feedback & General Comments
  252.     <pippy@endeavors.com>
  253.  
  254.     MAILING LISTS
  255.         Developer Issues
  256.         <pippy-dev@endeavors.org>
  257.         Bug Reports
  258.         <pippy-bugs@endeavors.org>
  259.         Announcements
  260.         <pippy-announce@endeavors.org>
  261.  
  262.     CVS REPOSITORY
  263.     <http://www.endeavors.com/pippy/download.html>
  264.  
  265.     Palm Developers Site
  266.     <http://www.palmos.com/dev/>
  267.  
  268.  
  269. AUTHORS
  270.  
  271.     Jeffery D. Collins <jcollins@endeavors.com>
  272.     Michael Gorlick <mgorlick@endeavors.com>
  273.     Endeavors Technology, Inc.
  274.     19700 Fairchild Rd, Suite 200
  275.     Irvine, CA  92612