summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2012-11-06 10:09:40 +1100
committerChris Johns <chrisj@rtems.org>2012-11-06 10:09:40 +1100
commitc80560d9a485880ff9b6a107fab7097b89d539ac (patch)
tree1d5d9771b2f59f1a4efb100287e077d558224d8f /doc
parentMerge branch 'master' of ssh://kiwi/opt/work/sw/rtems/tb/source-builder (diff)
downloadrtems-source-builder-c80560d9a485880ff9b6a107fab7097b89d539ac.tar.bz2
Move into the source-builder tree.
Diffstat (limited to 'doc')
-rw-r--r--doc/.gitignore2
-rw-r--r--doc/images/icons/README5
-rw-r--r--doc/images/icons/callouts/1.pngbin329 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/10.pngbin361 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/11.pngbin565 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/12.pngbin617 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/13.pngbin623 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/14.pngbin411 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/15.pngbin640 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/2.pngbin353 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/3.pngbin350 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/4.pngbin345 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/5.pngbin348 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/6.pngbin355 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/7.pngbin344 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/8.pngbin357 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/9.pngbin357 -> 0 bytes
-rw-r--r--doc/images/icons/caution.pngbin2734 -> 0 bytes
-rw-r--r--doc/images/icons/example.pngbin2599 -> 0 bytes
-rw-r--r--doc/images/icons/home.pngbin1340 -> 0 bytes
-rw-r--r--doc/images/icons/important.pngbin2980 -> 0 bytes
-rw-r--r--doc/images/icons/next.pngbin1302 -> 0 bytes
-rw-r--r--doc/images/icons/note.pngbin2494 -> 0 bytes
-rw-r--r--doc/images/icons/prev.pngbin1348 -> 0 bytes
-rw-r--r--doc/images/icons/tip.pngbin2718 -> 0 bytes
-rw-r--r--doc/images/icons/up.pngbin1320 -> 0 bytes
-rw-r--r--doc/images/icons/warning.pngbin3214 -> 0 bytes
-rw-r--r--doc/images/rtemswhitebg.jpgbin117890 -> 0 bytes
-rw-r--r--doc/source-builder.txt214
-rw-r--r--doc/wscript20
30 files changed, 0 insertions, 241 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
deleted file mode 100644
index 3af9e6f..0000000
--- a/doc/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-.lock-*
-build
diff --git a/doc/images/icons/README b/doc/images/icons/README
deleted file mode 100644
index f12b2a7..0000000
--- a/doc/images/icons/README
+++ /dev/null
@@ -1,5 +0,0 @@
-Replaced the plain DocBook XSL admonition icons with Jimmac's DocBook
-icons (http://jimmac.musichall.cz/ikony.php3). I dropped transparency
-from the Jimmac icons to get round MS IE and FOP PNG incompatibilies.
-
-Stuart Rackham
diff --git a/doc/images/icons/callouts/1.png b/doc/images/icons/callouts/1.png
deleted file mode 100644
index 7d47343..0000000
--- a/doc/images/icons/callouts/1.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/10.png b/doc/images/icons/callouts/10.png
deleted file mode 100644
index 997bbc8..0000000
--- a/doc/images/icons/callouts/10.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/11.png b/doc/images/icons/callouts/11.png
deleted file mode 100644
index ce47dac..0000000
--- a/doc/images/icons/callouts/11.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/12.png b/doc/images/icons/callouts/12.png
deleted file mode 100644
index 31daf4e..0000000
--- a/doc/images/icons/callouts/12.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/13.png b/doc/images/icons/callouts/13.png
deleted file mode 100644
index 14021a8..0000000
--- a/doc/images/icons/callouts/13.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/14.png b/doc/images/icons/callouts/14.png
deleted file mode 100644
index 64014b7..0000000
--- a/doc/images/icons/callouts/14.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/15.png b/doc/images/icons/callouts/15.png
deleted file mode 100644
index 0d65765..0000000
--- a/doc/images/icons/callouts/15.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/2.png b/doc/images/icons/callouts/2.png
deleted file mode 100644
index 5d09341..0000000
--- a/doc/images/icons/callouts/2.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/3.png b/doc/images/icons/callouts/3.png
deleted file mode 100644
index ef7b700..0000000
--- a/doc/images/icons/callouts/3.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/4.png b/doc/images/icons/callouts/4.png
deleted file mode 100644
index adb8364..0000000
--- a/doc/images/icons/callouts/4.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/5.png b/doc/images/icons/callouts/5.png
deleted file mode 100644
index 4d7eb46..0000000
--- a/doc/images/icons/callouts/5.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/6.png b/doc/images/icons/callouts/6.png
deleted file mode 100644
index 0ba694a..0000000
--- a/doc/images/icons/callouts/6.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/7.png b/doc/images/icons/callouts/7.png
deleted file mode 100644
index 472e96f..0000000
--- a/doc/images/icons/callouts/7.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/8.png b/doc/images/icons/callouts/8.png
deleted file mode 100644
index 5e60973..0000000
--- a/doc/images/icons/callouts/8.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/9.png b/doc/images/icons/callouts/9.png
deleted file mode 100644
index a0676d2..0000000
--- a/doc/images/icons/callouts/9.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/caution.png b/doc/images/icons/caution.png
deleted file mode 100644
index 9a8c515..0000000
--- a/doc/images/icons/caution.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/example.png b/doc/images/icons/example.png
deleted file mode 100644
index 1199e86..0000000
--- a/doc/images/icons/example.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/home.png b/doc/images/icons/home.png
deleted file mode 100644
index 37a5231..0000000
--- a/doc/images/icons/home.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/important.png b/doc/images/icons/important.png
deleted file mode 100644
index be685cc..0000000
--- a/doc/images/icons/important.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/next.png b/doc/images/icons/next.png
deleted file mode 100644
index 64e126b..0000000
--- a/doc/images/icons/next.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/note.png b/doc/images/icons/note.png
deleted file mode 100644
index 7c1f3e2..0000000
--- a/doc/images/icons/note.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/prev.png b/doc/images/icons/prev.png
deleted file mode 100644
index 3e8f12f..0000000
--- a/doc/images/icons/prev.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/tip.png b/doc/images/icons/tip.png
deleted file mode 100644
index f087c73..0000000
--- a/doc/images/icons/tip.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/up.png b/doc/images/icons/up.png
deleted file mode 100644
index 2db1ce6..0000000
--- a/doc/images/icons/up.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/warning.png b/doc/images/icons/warning.png
deleted file mode 100644
index d41edb9..0000000
--- a/doc/images/icons/warning.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/rtemswhitebg.jpg b/doc/images/rtemswhitebg.jpg
deleted file mode 100644
index f883f2c..0000000
--- a/doc/images/rtemswhitebg.jpg
+++ /dev/null
Binary files differ
diff --git a/doc/source-builder.txt b/doc/source-builder.txt
deleted file mode 100644
index 4558218..0000000
--- a/doc/source-builder.txt
+++ /dev/null
@@ -1,214 +0,0 @@
-Source Builder
-==============
-Chris Johns <chrisj@rtems.org>
-1.0, November 2012
-:doctype: book
-:toc:
-:icons:
-:numbered:
-
-image:images/rtemswhitebg.jpg["RTEMS",width="20%"]
-
-Introduction
-------------
-
-The Source Builder is a tool to aid building packages from source. It is not a
-package manager. It is just helps consolidate the details that you need to know
-to build a package from source. The tool is mainly aimed at those users who
-need to maintain tool sets for embedded type development, that is
-cross-compiled compiled tool chains, debuggers, and debugging aids. It is not
-limited to this role but designed to fit with-in that specific niche.
-
-The Source Builder attempts to support any host environment that runs Python
-and you can build the package on. It is not some sort of magic that can take
-any piece of source code and make it build. Someone at some point in time has
-figured out how to build that package from source and taught this tool.
-
-The Source Builder has two types configuration data. The first is configuration
-files and these are scripts based on the RPM spec file format that detail the
-steps needed to build a package. The steps are 'preparation', 'building', and
-'installing'. The second set of configuration files are 'build sets'. A build
-set describes a collection of packages you want built together. For example the
-GNU tool set is autoconf, automake, binutils, gcc, and gdb. This is the typical
-suite of tools you need for an embedded cross-development type project.
-
-The Source Builder does not interact with any host package management
-system. There is no automatic dependence checking between various packages you
-build or your host system may have installed. We assume you know what are doing
-or the build sets and configuration files you are using have been created by
-developers who do. A buld set should provide a known working configuration.
-
-Why build from source ?
-~~~~~~~~~~~~~~~~~~~~~~~
-
-If you are developing a system or product that has a long shelf life or is used
-in a critical piece of infastructure that has a long life cycle being able to
-build from source is important. It insulates the project from the fast ever
-changing world of the host development machines. If your tool set is binary and
-you have lost the ability to build it you have lost a degree of control and
-flexibility open source gives you. Fast moving host environments are
-fantastic. We have powerful multi-core computers with huge amounts of memory
-and state of the art operating systems to running on them. The product or
-project you are part of may need to be maintained well past the life time of
-these host. Being able to build from source an important and critical part of
-this process because you can move to a newer host and create an equivalent tool
-set.
-
-Building from source provides you with control over the configuration of the
-package you are building. If all or the most important dependent parts are
-built from source you limit the exposure to host variations. For example the
-GNU C compiler (gcc) currently uses a number of 3rd party libraries internally
-(gmp, mpfr, etc). If your validated compiler generating code for your target
-processor is dynamically linked against the host's version of these libraries
-any change in the host's configuration may effect you. The changes the host's
-package management system makes may be perfectly reasonible in relation to the
-distribution being managed how-ever this may not extend to you and your
-tools. Building your tools from source and controlling the specific version of
-these dependent parts means you are not exposing yourself to unexpected and
-often difficult to resolve problems. On the other side you need to make sure
-your tools build and work with newer versions of the host operating
-sytem. Given the stability of standards based libraries like 'libc' and ever
-improving support for standard header file locations this task is becoming
-easier.
-
-History
-~~~~~~~
-
-The Source Builder is a stand alone tool based on another tool called the
-'SpecBuilder'. The SpecBuilder was written for the RTEMS project too give me a
-way to build tools on hosts that did not support RPMs. At the time the RTEMS
-tools maintainer only used spec files to create various packages. This meant I
-had either spec files, RPM files or SRPM files. The RPM and SPRM files where
-useless because you needed an 'rpm' type tool to extract and manage them. There
-are versions of 'rpm' for a number of non-RPM hosts how-ever these proved to be
-in various broken states and randomally maintained. The solution I settled on
-was to use spec files so I wrote a Python based tool that parsed the spec file
-format and allowed me to create a shell script I could run to build the
-package. This approach proved successful and I was able to track the RPM
-version of the RTEMS tools on a non-RPM host over a number of years. How-ever
-the SpecBuilder tool did not help me build tools or other packages not related
-to the RTEMS project where there was no spec file I could use so I needed
-another tool. Rather than start again I decided to take the parsing code for
-the spec file format and build a new tool called the Source Builder.
-
-Quick Start
------------
-
-Check out the Source Builder tool from git:
-
--------------------------------------------------------------
-$ git clone git://git.rtems.org/source-builder.git
--------------------------------------------------------------
-
-The first step is to check if your host is set up correctly:
-
--------------------------------------------------------------
-$ source-builder/sb-check
-warning: exe: absolute exe found in path: (__objcopy) /usr/local/bin/objcopy <1>
-warning: exe: absolute exe found in path: (__objdump) /usr/local/bin/objdump
-error: exe: not found: (_xz) /usr/local/bin/xz <2>
-Source Builder environent is not correctly set up
-$ source-builder/sb-check
-Source Builder environent is ok <3>
--------------------------------------------------------------
-
-<1> A tool is in the environment path but does not match the shown path.
-<2> The executable 'xz' is not found.
-<3> The host's environment is set up correct.
-
-If there are problems you are given a list of executables that cannot be
-found. You may also be given a list of warnings about executables not in the
-expected location how-ever the executable was located somewhere in your
-environment's path. You will need to check the specific host section to resolve
-these issues.
-
-Create a suitable build directory away from the Source Builder source change
-into that directory and build a GNU tool set:
-
--------------------------------------------------------------
-$ mkdir gnu-tools <1>
-$ cd gnu-tools
-$ ../source-builder/sb-set-builder <2> --log=l.txt <3> --force <4> \
- --prefix=$HOME/gnu-tools-1 <5> --target=arm-eabi <6> gnu-toolset-4.6 <7>
--------------------------------------------------------------
-
-<1> Make a build directory you can delete when finished.
-<2> The Source Builder command to build a set of tools.
-<3> Capture the output to a log file.
-<4> The force option will create any needed directories and allow the build to
-proceed if your host is not set up.
-<5> Give the tools a suitable prefix. This is the location you install the
-tools into once they have built.
-<6> The gnu-toolset requires you set a target. In this case the tool set will
-be a generic unpatched version of GCC 4.6 for a bare metal the ARM processor.
-<7> The build set.
-
-To view the build sets lets change to the RTEMS project's source builder
-configuration and then list the build sets:
-
--------------------------------------------------------------
-$ cd ../rtems-source-builder
-$ ../source-builder/sb-set-builder --list-bsets
-Source Builder - Set Builder, v0.1
-Examining: /usr/home/chris/development/rtems/src/rtems-source-builder/config <1>
-Examining: /usr/home/chris/development/rtems/src/source-builder/config <2>
- gnu-tools-4.6 <3>
- rtems-tools-4.10 <4>
--------------------------------------------------------------
-
-<1> The local RTEMS configuration directory. Searched first.
-<2> The Source Builder configuration directory.
-<3> The Source Builder provided GNU tools GCC 4.6 build set.
-<4> The RTEMS Source Builder provided RTEMS 4.10 build set.
-
-And to view the configurations you can:
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --list-configs
-Source Builder - Set Builder, v0.1
-Examining: /usr/home/chris/development/rtems/src/rtems-source-builder/config
-Examining: /usr/home/chris/development/rtems/src/source-builder/config
- autoconf-2-1 <1>
- autoconf-2.68-1
- autoconf-2.69-1
- autoconf-internal-2.68-1
- automake-1-1
- automake-1.12-1
- automake-internal-1.12-1
- base
- binutils-2-1
- binutils-2.22-1
- checks
- expat-2-1
- expat-2.1.0-1
- gcc-4.4-1
- gcc-4.6-1
- gcc-4.6-newlib-1.20-1
- gdb-7-1
- gdb-7.5-1
- libusb-1-1
- libusb-1.0.9-1
- m4-1-1
- m4-1.4.16-1
- texane-stlink-1
- rtems-binutils-2.20.1-1
- rtems-gcc-4.4.7-newlib-1.18.0-1
- rtems-gdb-7.3.1-1
--------------------------------------------------------------
-
-<1> Configurations are built by using the builder. This creates a stand alone
-package.
-
-The Source Builder
-------------------
-
-The Source Builder provides a few generic build sets and the configuration
-support to build a number of packages. A project that uses the Source Builder
-can create a specialised set of configuration files that provides the specific
-configurations thet project uses.
-
-For example the RTEMS project provides its own set of configuration files. In
-the build set list in the 'Quick Start' section you can see a build set
-+rtems-tools-4.10+. This build set defines the extact configration to use for
-the RTEMS 4.10 release.
-
diff --git a/doc/wscript b/doc/wscript
deleted file mode 100644
index 9685ebf..0000000
--- a/doc/wscript
+++ /dev/null
@@ -1,20 +0,0 @@
-#
-# Waf build script to build the Source Builder Documentation.
-#
-
-version = "1.0.0"
-
-def configure(ctx):
- ctx.env.ASCIIDOC = ctx.find_program(['asciidoc.py'], mandatory = True)
- ctx.env.ASCIIDOC_FLAGS = ['-b', 'html', '-a', 'data-uri', '-a', 'icons', '-a', 'max-width=55em-a']
-
-def build(ctx):
- ctx(target = 'source-builder.html', source = 'source-builder.txt')
-
-import waflib.TaskGen
-waflib.TaskGen.declare_chain(name = 'html',
- rule = '${ASCIIDOC} ${ASCIIDOC_FLAGS} -o ${TGT} ${SRC}',
- shell = False,
- ext_in = '.txt',
- ext_out = '.html',
- reentrant = False)