[chatter] r11805 - in trunk/documentation/topic: concept reference
housel at mccarthy.opendylan.org
housel at mccarthy.opendylan.org
Sun May 11 07:32:47 CEST 2008
Author: housel
Date: Sun May 11 07:32:46 2008
New Revision: 11805
Added:
trunk/documentation/topic/concept/build-system.xml (contents, props changed)
trunk/documentation/topic/reference/jam-builtins.xml (contents, props changed)
trunk/documentation/topic/reference/jam-pseudo-targets.xml (contents, props changed)
Modified:
trunk/documentation/topic/concept/jam.xml
Log:
Bug: 7249 7003
Convert more of the Jam-based build-system documentation to DITA topics.
Added: trunk/documentation/topic/concept/build-system.xml
==============================================================================
--- (empty file)
+++ trunk/documentation/topic/concept/build-system.xml Sun May 11 07:32:46 2008
@@ -0,0 +1,19 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" []>
+<concept id="concept-build-system">
+ <title>Open Dylan Build System</title>
+ <conbody>
+ <p>The purpose of the Open Dylan <apiname>build-system</apiname>
+ is to coördinate the final stages in the building of a Dylan
+ library project. The Open Dylan compiler takes a Dylan library in
+ the form of Dylan source files, and directly generates x86 or PPC
+ machine language object files (in either COFF or ELF format,
+ depending on the target platform). These object files need to be
+ linked together to construct either an executable object file, or
+ a loadable dynamically-linked library (also called a shared
+ library). This link needs to performed by an external tool such as
+ the Microsoft or GNU linker. The <apiname>build-system</apiname>
+ component, controlled by a user-specified script file, directs the
+ execution of these external tools.</p>
+ </conbody>
+</concept>
Modified: trunk/documentation/topic/concept/jam.xml
==============================================================================
--- trunk/documentation/topic/concept/jam.xml (original)
+++ trunk/documentation/topic/concept/jam.xml Sun May 11 07:32:46 2008
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" []>
-<concept id="concept-1">
+<concept id="jam">
<title>Jam</title>
<conbody>
<p><xref href="http://www.perforce.com/jam/jam.html">Jam</xref> is
Added: trunk/documentation/topic/reference/jam-builtins.xml
==============================================================================
--- (empty file)
+++ trunk/documentation/topic/reference/jam-builtins.xml Sun May 11 07:32:46 2008
@@ -0,0 +1,40 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd" []>
+<reference id="reference-1">
+ <title>Additional Built-In Jam Rules</title>
+ <refbody>
+ <section>
+ <p>The build system defines the following built-in rules in addition to the ones described in <xref href="http://public.perforce.com/public/jam/src/Jam.html">the Jam manual page</xref>.</p>
+ </section>
+ </refbody>
+ <reference id="reference-jam-builtins-DFMCMangle">
+ <title>DFMCMangle</title>
+ <refbody>
+ <refsyn>
+ <synph>
+ <kwd>DFMCMangle</kwd>
+ <parmname>name</parmname>
+ <delim>;</delim>
+ </synph>
+ </refsyn>
+ <section>
+ <p>Mangle the given <parmname>name</parmname> according to the Open Dylan compiler's name mangling rules. If <parmname>name</parmname> has a single component, it is considered to be a <q>raw</q> name; if there are three components they correspond to the variable-name, module-name, and library-name respectively.</p>
+ </section>
+ </refbody>
+ </reference>
+ <reference id="jam-builtin-IncludeMKF">
+ <title>IncludeMKF</title>
+ <refbody>
+ <refsyn>
+ <synph>
+ <kwd>IncludeMKF</kwd>
+ <parmname>includes</parmname>
+ <delim>;</delim>
+ </synph>
+ </refsyn>
+ <section>
+ <p>Read each of the given <filepath>.mkf</filepath> files and invoke Jam rules as described <xref href="jam-invoked-rules.xml">here</xref>.</p>
+ </section>
+ </refbody>
+ </reference>
+</reference>
Added: trunk/documentation/topic/reference/jam-pseudo-targets.xml
==============================================================================
--- (empty file)
+++ trunk/documentation/topic/reference/jam-pseudo-targets.xml Sun May 11 07:32:46 2008
@@ -0,0 +1,47 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd" []>
+<reference id="reference-jam-pseudo-targets">
+ <title>Build System Pseudo-targets</title>
+
+ <refbody>
+ <section>
+ <p>The Open Dylan compiler expects the build script to define
+ the following pseudo (<codeph>NotFile</codeph>) targets:</p>
+
+ <dl>
+ <dlentry>
+ <dt>exports</dt>
+ <dd>Not currently implemented.</dd>
+ </dlentry>
+ <dlentry>
+ <dt>unify-dll</dt>
+ <dd>Link the project as a dynamically-linked library, with some of the dependent libraries included as part of the same library image. Not currently implemented.</dd>
+ </dlentry>
+ <dlentry>
+ <dt>dll</dt>
+ <dd>Link the project as a dynamically-linked library.</dd>
+ </dlentry>
+ <dlentry>
+ <dt>unify-exe</dt>
+ <dd>Link the project as an executable program, with selected dependent libraries included as part of the same executable image. Not currently implemented.</dd>
+ </dlentry>
+ <dlentry>
+ <dt>exe</dt>
+ <dd>Link the project as an executable program.</dd>
+ </dlentry>
+ <dlentry>
+ <dt>release</dt>
+ <dd>Not currently implemented.</dd>
+ </dlentry>
+ <dlentry>
+ <dt>clean-all</dt>
+ <dd>Remove build products in the top-level project, and in all of the non-system libraries that it uses.</dd>
+ </dlentry>
+ <dlentry>
+ <dt>clean</dt>
+ <dd>Remove build products in the top-level project.</dd>
+ </dlentry>
+ </dl>
+ </section>
+ </refbody>
+</reference>
More information about the chatter
mailing list