Changeset 433 for pjproject/trunk/README-configure

Timestamp:

May 10, 2006 7:24:40 PM (18 years ago)

Author:

bennylp

Message:

Merge-in RTEMS port patch by Phil Torre <ptorre@…>, alpha release.

File:

• pjproject/trunk/README-configure (moved) (moved from pjproject/trunk/build.mak.txt) (1 diff)

pjproject/trunk/README-configure

@@ -1 @@
-#
-# This file contains all possible values for the build.mak. Select
-# the appropriate settings, and put it in build.mak.
-#
-# (Just in case "./configure" fails to detect the appropriate values).
-#
-# Build configurations:
-#
-# MACHINE_NAME values: 
-#       - i386 (generic x86)
-#       - sparc
-#       - alpha
-#
-# OS_NAME values:
-#       - win32 (generic windows)
-#       - linux
-#       - sunos
-#
-# CC_NAME values:
-#       - gcc
-#       - msvc
-#
-# HOST_NAME values:
-#       - win32 (Windows command line)
-#       - mingw (Windows, mingw)
-#       - unix
-#
 
-#
-# PalmOS 6 cross-compile, cygwin
-#
-#export MACHINE_NAME := m68k
-#export OS_NAME := palmos
-#export CC_NAME := gcc
-#export HOST_NAME := mingw
+   Configuring the Build System
+   Update: 04 May 2006
 
-#
-# Win32, mingw
-#
-#export MACHINE_NAME := i386
-#export OS_NAME := win32
-#export CC_NAME := gcc
-#export HOST_NAME := mingw
 
-#
-# Linux i386, gcc
-#
-export MACHINE_NAME := i386
-export OS_NAME := linux
-export CC_NAME := gcc
-export HOST_NAME := unix
+  1. Overview
+  
+  The "configure" script in pjproject root directory is not an autoconf script,
+but it's just a custom script to generate "build.mak" for the build system. 
+The "build.mak" file declares the following global Makefile variables:
 
-#
-# Linux KERNEL i386, gcc
-#
-#export MACHINE_NAME := i386
-#export OS_NAME := linux-kernel
-#export CC_NAME := gcc
-#export HOST_NAME := unix
-#export PJPROJECT_DIR := /usr/src/pjproject-0.3
-##export KERNEL_DIR = /usr/src/linux
-#export KERNEL_DIR = /usr/src/uml/linux
-#export KERNEL_ARCH = ARCH=um
+  MACHINE_NAME
+    The processor and hardware platform of the target. For each MACHINE_NAME,
+    there must be matching "m-*.mak" entry in "build/" subdirectory. For 
+    example, when MACHINE_NAME is declared as "i386", then there must be 
+    "m-i386.mak" file in "build/" subdirectory.
+  
+  OS_NAME
+    Operating system name, determines which "os-*.mak" in "build/" dir to use.
 
-#
-# SunOS, sparc, gcc
-#
-#export MACHINE_NAME := sparc
-#export OS_NAME := sunos
-#export CC_NAME := gcc
-#export HOST_NAME := unix
+  HOST_NAME
+     Build host name, determines which "host-*.mak" to use.
 
+  CC_NAME
+     Compiler name, determines which "cc-*.mak" to use.
+
+  TARGET_NAME
+     Determines suffix to be added to output files (for example,
+     "libpjsip-i386-linux-gcc.a"). The value normally is equal to
+     $(MACHINE_NAME)-$(OS_NAME)-$(CC_NAME), but it can contain any value.
+  
+  CROSS_COMPILE
+     Determine the prefix to be applied when invoking build tools (for
+     example, "powerpc-rtems-"). The default is empty.
+
+
+  At present, the configure script CAN NOT be used for configuring cross
+compilation. For cross compiling, you must create the "build.mak" file
+manually.
+
+
+  2. Supported Hosts and Targets
+
+  The number of supported hosts and targets will (hopefully) increase over time.
+See "build/" subdirectory for list of supported machines, OSes, hosts, and
+compilers.
+