|
|
Boost-Commit : |
From: ghost_at_[hidden]
Date: 2007-10-12 15:06:46
Author: vladimir_prus
Date: 2007-10-12 15:06:45 EDT (Fri, 12 Oct 2007)
New Revision: 39966
URL: http://svn.boost.org/trac/boost/changeset/39966
Log:
Remove documents that are on Wiki now.
Removed:
branches/build/python_port/python/DESIGN.txt
Text files modified:
branches/build/python_port/python/README.txt | 42 ++-------------------------------------
1 files changed, 3 insertions(+), 39 deletions(-)
Deleted: branches/build/python_port/python/DESIGN.txt
==============================================================================
--- branches/build/python_port/python/DESIGN.txt 2007-10-12 15:06:45 EDT (Fri, 12 Oct 2007)
+++ (empty file)
@@ -1,132 +0,0 @@
-
-This document outlines the goals, and internal design of the Boost.Build V2
-port to Python.
-
-= Goals =
-
-Using of bjam language as implementation language has two drawbacks:
-
- - No user knows that language
- - The language decisions (like using list of strings as primary
- datatype) makes implementation slow and memory-hungry.
-
-The primary goal of the port is to replicate exactly the same functionality,
-and the same design and the same code, and get all the tests still work.
-The only design/code changes allowed during the port are:
-
- - No globals -- all data that is global in existing code will be
- kepts inside Python object that are kept inside single top-level
- "manager" object. This applies only to core code -- the
- tools layer will use globals for now.
- - Build actions in Python -- in case where jam code, for a given
- command line, has both a command line proper and procedural
- code to setup something, said procedural code will be moved in
- Python -- while the command line will be declared using Jam syntax.
- - Using of Python facilities. Python datatypes and builtin modules
- will be used.
- - Using of the property_set class. Unless required for compatibility
- with Jamfiles, we'll be using property_set in all remaining cases
- where raw property list is used now.
- - Path normalization. We only need path normalization when loading
- Jamfiles, to make sure we don't load the same Jamfile twice,
- no matter what path is used to refer to is. Other than that,
- all path normalization logic will be dropped.
-
-= Design: Physical structure =
-
-The entire code base is divided in two parts -- Boost.Build proper and bjam.
-Boost.Build is written in Python. bjam is a build engine, written in C, and
-provides two major features:
- - Parsing of project description files, called Jamfiles
- - Build engine functionality -- detecting out-of-date
- targets and running commands to make them out of date.
-
-The entry point is bjam, which is linked to Python interpreter. On startup,
-bjam imports Python main function and calls it, from which point Python
-is in control. We can alternatively create an extension library from
-bjam, and call that from Python, but this is not important design aspect.
-
-= Design: Logical structure =
-
-There's one top-level object -- manager -- of type boost.build.Manager.
-It holds all global definitions -- set of tools, features, project
-tree.
-
-- Project loading level
-- Metatargets level
-- Virtual targets level.
-- Engine level
-
-== Bjam engine level ==
-
-On the bjam engine level, we have bjam targets and bjam
-actions. Bjam target is just a string. It can have arbitrary
-set of (variable-name,value) pairs associated with it.
-
-
-An action has a name, and a body. Body actually specifies the
-command that should be executed, and body can make use
-of the variables defined on targets. See bjam docs for more details.
-
-In Python port, the bjam engine level is represented by the boost.build.engine
-package. The Engine class is abstract base, and BjamEngine is concrete
-implementation. The basic operation is to specify that certain targets
-are produced from other other targets using specified action. This
-is done by the 'set_update_action' method.
-
-The targets are strings, they don't need any declarations. The actions
-however do need declarations. There are two
-
-
-The bjam targets are strings, and don't need special
-declaration. The actions, however, do need special declaration, and
-there are two methods to declare a target
-
-= Hints =
-
-All code callable from Jam gets string *list* and *every*
-argument. When logically, only a single string is allowed,
-use [0].
-
-
-= Bjam <-> Python interface =
-
-
-== Bjam side ==
-
-The EXTRA_PYTHONPATH variable, in the global module,
-should be a list with directories where Python modules
-QWERTY
-
-From Bjam side, a single extra rule is available:
-
- PYTHON_IMPORT_RULE <python-module> : <callable>
- : <bjam-module> : <name> ;
-
-This imports a python callable object from the
-specified module into bjam.
-
-== Python side ==
-
-The following functions are avaiable from python, in the
-bjam module.
-
-1. call <name>, <param0>, <param1>, ....
-Looksup <name> in bjam module 'python_interface'. If found, calls
-that rule, passsing <param0>, <paramN>. Each <paramI> should be
-a list of strings.
-
-2. import_rule <bjam module>, <bjam name>, <callable>
-Adds new rule <bjam name> to <bjam module>. Calling that rule
-will call back to Python <callable> -- which should accept
-lists of strings as parameters.
-
-3. define_action action_name, action_body, bind_list, flags.
-
-Defines new action with specified name, body, list if bound
-variables and flags. The action is created in the global module.
-
-4. variable name
-
-Obtains the value of a variable 'name' in Jam's global module.
-
Modified: branches/build/python_port/python/README.txt
==============================================================================
--- branches/build/python_port/python/README.txt (original)
+++ branches/build/python_port/python/README.txt 2007-10-12 15:06:45 EDT (Fri, 12 Oct 2007)
@@ -1,40 +1,4 @@
-This directory contains experimental port of Boost.Build V2 to Python.
-The explanations why this is needed, and some guidelines can be found
-in the doc/Overview.txt file. Unless you're interested in working on that
-port, you probably should not read this document.
-
-To try the port, you need this:
-
-1. Get yourself a fresh version of bjam. In the build.jam file,
- find the
-
- HAVE_PYTHON = 0 ;
-
- line and change it to
-
- HAVE_PYTHON = 1 ;
-
- You might want to edit Python location too. Rebuild bjam with
-
- ./build.sh --debug
-
- (The '--debug' option is required, bjam will crash without it)
-
- and place the binary in PATH (don't forget that debug binary is built
- to a different directory.
-
-2. Get yourself up-to-date version of Python port:
-
- cvs up -r BOOST_BUILD_PYTHON python
-
-3. Get top-level module for Python port:
-
- cvs up -r BOOST_BUILD_PYTHON pybb.jam
-
-4. Go to python/tests/bjam/make and run
-
- bjam --build-system=pybb
-
-
-
\ No newline at end of file
+Please see http://zigzag.cs.msu.su/boost.build/wiki/PythonPort
+for instruction how to use Python port, design notes and
+development guidelines.
\ No newline at end of file
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk