autoproj 1.7.0.rc2 → 1.7.0

data/doc/guide/config.yaml

@@ -1,29 +0,0 @@
-# This is the YAML configuration file for webgen used to set configuration options.
-#
-# The general syntax is:
-#
-#   configuration.option.name: value
-#
-# For example, to set a different default language, you would do:
-#
-#   website.lang: de
-#
-# Have a look at the documentation of the individual configuration options to see
-# the allowed format of the values. Since this is a YAML file, you can easily set
-# configuration options to strings, integers, dates, arrays, hashes and more.
-#
-# The available configuration options can be listed using the `webgen config`
-# command, for example: `webgen config sourcehandler` will list all options starting
-# with sourcehandler.
-
-default_meta_info:
-    Webgen::SourceHandler::Page:
-        in_menu: true
-
-tag.menu.nested: false
-
-tag.breadcrumbtrail.omit_index_path: true
-
-tag.coderay.line_numbers: false
-tag.coderay.lang: ruby
-

data/doc/guide/ext/init.rb

@@ -1,18 +0,0 @@
-# = webgen extensions directory
-#
-# All init.rb files anywhere under this directory get automatically loaded on a webgen run. This
-# allows you to add your own extensions to webgen or to modify webgen's core!
-#
-# If you don't need this feature you can savely delete this file and the directory in which it is!
-#
-# The +config+ variable below can be used to access the Webgen::Configuration object for the current
-# website.
-config = Webgen::WebsiteAccess.website.config
-
-config = Webgen::WebsiteAccess.website.config
-config['sourcehandler.patterns']['Webgen::SourceHandler::Copy'] << '**/autoproj_bootstrap'
-config['sourcehandler.patterns']['Webgen::SourceHandler::Copy'] << '**/manifest.xml'
-
-$LOAD_PATH.unshift File.expand_path('..', File.dirname(__FILE__))
-require 'ext/rdoc_links'
-require 'ext/previous_next'

data/doc/guide/ext/previous_next.rb

@@ -1,40 +0,0 @@
-require 'webgen/tag'
-class PrevNextTag
-    include Webgen::Tag::Base
-
-    def call(tag, body, context)
-        node = context.content_node
-        while !node.is_file?
-            node = node.parent
-        end
-
-        siblings = node.parent.children.sort
-        siblings.delete_if { |n| !n.meta_info['in_menu'] }
-        prev, _ = siblings.
-            enum_for(:each_cons, 2).
-            find { |prev, this| this == node }
-        _, nxt = siblings.
-            enum_for(:each_cons, 2).
-            find { |this, nxt| this == node }
-
-        content = if tag == "next" && nxt
-                      node.link_to(nxt)
-                  elsif tag == "previous" && prev
-                      node.link_to(prev)
-                  end
-
-        if content
-            if !body.empty?
-                body.gsub '%', content
-            else
-                content
-            end
-        end
-    end
-end
-
-config = Webgen::WebsiteAccess.website.config
-config['contentprocessor.tags.map']['previous'] = 'PrevNextTag'
-config['contentprocessor.tags.map']['next'] = 'PrevNextTag'
-
-

data/doc/guide/ext/rdoc_links.rb

@@ -1,33 +0,0 @@
-require 'webgen/tag'
-class RdocLinks
-    include Webgen::Tag::Base
-
-    def call(tag, body, context)
-        name = param('rdoclinks.name')
-        if base_module = param('rdoclinks.base_module')
-            name = base_module + "::" + name
-        end
-
-        if name =~ /(?:\.|#)(\w+)$/
-            class_name  = $` 
-            method_name = $1
-        else
-            class_name = name
-        end
-
-        path = class_name.split('::')
-        path[-1] += ".html"
-        url = "#{param('rdoclinks.base_url')}/#{path.join("/")}"
-
-        "<a href=\"#{context.ref_node.route_to(url)}\">#{param('rdoclinks.name')}</a>"
-    end
-end
-
-config = Webgen::WebsiteAccess.website.config
-config.rdoclinks.name        "", :mandatory => 'default'
-config.rdoclinks.base_webgen "", :mandatory => false
-config.rdoclinks.base_url    "", :mandatory => false
-config.rdoclinks.base_module nil, :mandatory => false
-config.rdoclinks.full_name   false, :mandatory => false
-config['contentprocessor.tags.map']['rdoc_class'] = 'RdocLinks'
-

data/doc/guide/src/adding_packages.page

@@ -1,40 +0,0 @@
----
-title: Adding packages (for the impatient)
-sort_info: 50
----
-
-To register a package in autoproj, you need to basically do two things
-
- * declare it in an autobuild file
- * add VCS information for it (i.e. "where to get it")
-
-A first step
-------------
-
-A quick thing that can be done to register a new package in your autoproj
-installation is to add it to the local package set.
-
- * [register it](package_sets/autobuild.html) in
-   <tt>autoproj/local.autobuild</tt>
- * [give version control information](package_sets/importers.html) for it in
-   <tt>autoproj/overrides.yml</tt>
-
-Alternatively to the last point, you can register it under the "type: none"
-importer in autoproj/overrides.yml to make autoproj not care about updating that
-package.
-
-Sharing package definitions with the rest of the world
-------------------------------------------------------
-
-To do that, you will either have to move the package definition to a separate
-package set (usually one of those that are in autoproj/remotes/), or to create
-your own package set]
-
-For the first solution, you will have to move the package definition from
-autoproj/local.autobuild to an autobuild file in the package set directory (name
-does not matter as long as it ends with .autobuild). Moreover, you will have to
-move the importer definition from autoproj/overrides.yml to the package set's
-source.yml file.
-
-For the second solution, [read on](package_sets/index.html)
-

data/doc/guide/src/customization.page

@@ -1,230 +0,0 @@
----
-title: Customizing the installation
-sort_info: 75
----
-
-Changing the installation's layout
-----------------------------------
-
-The <tt>layout</tt> section of <tt>autoproj/manifest</tt> offers two things:
-
- * select which packages/package sets to build and
- * build packages in specific subdirectories
-
-This section lists packages or package sets that ought to be built by autoproj.
-For instance, in the following example, only the <tt>orocos/rtt</tt> and <tt>orocos/ocl</tt>
-packages of the rubim.orocos source will be built. The other will be excluded
-from the build.
-
-{coderay:: yaml}
-package_sets:
-  - type: git
-    url: git://github.com/doudou/rubim.orocos.git
-
-layout:
-  - orocos/rtt
-  - orocos/ocl
-{coderay}
-
-Instead of giving a package name, the name of a package set can be provided,
-which translates into "all the packages of that set".
-
-As we mentionned before, the layout mechanism also allows you to place packages
-in subdirectories of the main installation. For instance, the following snippet
-will build the <tt>typelib</tt>, <tt>utilmm</tt> and <tt>utilrb</tt> libraries of rubim.orocos into
-the <tt>lib/</tt> subdirectory and all the <tt>orocos/</tt> packages in the root.
-
-{coderay:: yaml}
-layout:
-  - lib:
-    - typelib
-    - utilmm
-    - utilrb
-  - orocos/
-{coderay}
-
-Configuration files like <tt>autoproj/manifest</tt> are YAML file. As such, they
-aresensible to indentation. The snippet above should be read as: in the layout, there is first a "lib" part and second the packages whose names start with "orocos/" _(first level of indentation)_. In the "lib" part, the packages are "typelib", "utilmm"
- and "utilrb" _(second level of indentation)_. 
-{: .warning}
-
-Alternatively, the example above could be written:
-{coderay:: yaml}
-layout:
-  - lib: [typelib, utilmm, utilrb]
-  - orocos/
-{coderay}
-
-Finally, names of sublayouts can be used as arguments in the autoproj command
-line, instead of package names:
-
-autoproj build lib
-{: .commandline}
-
-Removing packages from the build (<tt>exclude_packages</tt>) {#exclude_packages}
---------------------------------
-Instead of having to list all packages that you do want to build, it is possible
-to list the packages that you don't want to build. Simply list them in the
-<tt>exclude_packages</tt> section of the manifest file. In the following example, all
-of the rubim.orocos package set will be built *but* the pocosim-log package.
-
-{coderay:: yaml}
-layout:
-  - rubim.orocos
-
-exclude_packages:
-  - pocosim-log
-{coderay}
-
-If another package, that should be built, depends on an excluded package, [an
-error is generated](error_messages.html#exclusions)
-
-Using packages that are already installed (<tt>ignore_packages</tt>) 
------------------------------------------
-
-If some packages are already installed elsewhere, and you want to use that
-version instead of the one listed in the package sets, list them in the
-<tt>ignore_packages</tt> section of the manifest. In the following example, the
-<tt>orocos/rtt</tt> package will *not* be built by autoproj.
-
-{coderay:: yaml}
-layout:
-  - rubim.orocos
-
-exclude_packages:
-  - pocosim-log
-
-ignore_packages:
-  - orocos/rtt
-{coderay}
-
-Unlike with <tt>exclude_packages</tt>, no error is generated for ignored
-packages that are depended-upon by other packages in the build. This is because
-ignore_packages is meant to list packages that are already installed outside of
-autoproj, while exclude_packages lists what you do **not** want to have at all.
-
-Local overrides of version control information
-----------------------------------------------
-
-The <tt>autoproj/overrides.yml</tt> allows you to override version control information
-for specific packages. It has the same format than the source.yml file of
-package sets, so [check that page out](package_sets/importers.html) for more information.
-
-This file can in particular be used to avoid further updates to a given software
-package. Simply do:
-
-{coderay:: yaml}
-overrides:
-  - orocos/rtt:
-    type: none
-{coderay}
-
-To track a different branch that the default branch, you will have to do:
-
-{coderay:: yaml}
-overrides:
-  - orocos/rtt:
-    branch: experimental
-{coderay}
-
-Tuning what files autoproj looks at to determine if a package should be updated
--------------------------------------------------------------------------------
-When a package A depends on a package B, autoproj checks if some of the files in
-B's directory are newer than the latest build of A. If it is the case, it will
-trigger the build of B and then the one of A.
-
-Autoproj has a default list of files that it should ignore. Unfortunately, it
-may be that you are generating some files in the source directory that autoproj
-interprets as new files and trigger builds.
-
-If you have the impression that autoproj does too many rebuilds, run the build
-once with the <tt>--list-newest-files</tt> option. For instance,
-
-autoproj --list-newest-files fast-build
-{: .cmdline}
-
-If you find some files that should be ignored, add them either to the package
-sets (i.e. autoproj/remotes/blablab/init.rb) or in autoproj/init.rb with
-
-{coderay:: ruby}
-ignore /a_regular_expression/
-{coderay}
-
-where /a_regular_expression/ is a regular expression matching your files. For
-instance, to eliminate all files that have an extension in ".swp", one would do
-
-{coderay:: ruby}
-ignore /\.swp$/
-{coderay}
-
-Building local packages
------------------------
-
-You can list local packages that are not in an imported package set by placing
-the definitions in autoproj/, in a file ending with <tt>.autobuild</tt>. See [this
-page](package_sets/autobuild.html) for information on how to write autobuild files.
-
-Setting up the path to specific commands (make, parallel builds)
-----------------------------------------------------------------
-
-The autobuild API allows to specify what specific installed command to use for
-each tool needed during the build. These commands can be used in
-<tt>autoproj/init.rb</tt> to tune the build system. Example:
-
-{coderay:: ruby}
-Autobuild.commands['make'] = '/path/to/ccmake'
-Autobuild.parallel_build_level = 10 # build with -j10
-{coderay}
-
-More complex customization
---------------------------
-
-More complex customization can be achieved by accessing the [Autoproj API](api/index.html) and
-the [Autobuild API](http://doudou.github.com/autobuild/index.html) directly in the <tt>autoproj/init.rb</tt> and
-<tt>autoproj/overrides.rb</tt>
-files. The former is loaded before all source files and the latter is loaded
-after all source files.
-
-Some examples:
-
- * fixing dependencies: if a dependency is not listed in a package's manifest,
-   then you can fix it by adding the following in <tt>autoproj/overrides.rb</tt>
-   {coderay:: ruby}
-   a = Autobuild::Package['a_package']
-   a.depends_on "other_package"
-   {coderay}
-
- * changing the configuration of some cmake package:
-   {coderay:: ruby}
-   a = Autobuild::Package['a_package']
-   a.define "CONFIG_VAR", "CONFIG_VALUE"
-   {coderay}
-
-Building packages selectively on the command line
--------------------------------------------------
-
-The autoproj command line accepts subdirectories defined in the layout as well
-as package names.
-
-For instance, with the following layout:
-
-{coderay:: yaml}
-layout:
-  - typelib
-  - asguard:
-    - modules/base
-    - modules/logger
-{coderay}
-
-If the command line is
-
-autoproj build modules/logger
-{: .commandline}
-
-then modules/logger and its dependencies will be built. Idem, if the command line is:
-
-autoproj build asguard
-{: .commandline}
-
-then all packages or asguard/ are built, including their dependencies
-

data/doc/guide/src/default.css

@@ -1,340 +0,0 @@
-/* andreas03 - an open source xhtml/css website layout by Andreas Viklund - http://andreasviklund.com . Free to use for any purpose as long as the proper credits are given to the original author.
-
-Version: 1.2
-(Nov 28, 2005)
-
-Screen layout: */
-
-body{
-margin:0;
-padding:30px 0;
-font:76% tahoma,verdana,sans-serif;
-background:#047 url(images/bodybg.png) repeat-x fixed;
-color:#222;
-}
-
-#thetop{
-margin:0;
-}
-
-#container{
-width:720px;
-margin:0 auto;
-padding:20px 20px 0 20px;
-background:#fff url(images/contbg.png) no-repeat;
-color:#222;
-}
-
-a{
-text-decoration:none;
-background-color:inherit;
-color:#26c;
-}
-
-a:hover {
-text-decoration:underline;
-}
-
-img.full {
-margin-left: auto;
-margin-right: auto;
-margin-top: 2em;
-margin-bottom: 2em;
-}
-
-a img{
-border:0;
-}
-
-p{
-margin:0 0 15px 0;
-line-height:1.5em;
-}
-
-#main p,#sidebar p{
-padding:0 0 0 10px;
-}
-
-#logo{
-float:left;
-width:240px;
-margin:0 20px 0 0;
-padding:0 0 25px 0;
-background:#eee;
-border:4px solid #dde;
-text-align:center;
-color:#555;
-overflow:auto;
-}
-
-#logo h1{
-margin:50px 5px 1px 5px;
-letter-spacing:-3px;
-}
-
-#logo a{
-background-color:inherit;
-color:#26a;
-text-decoration:none;
-}
-
-#logo a:hover{
-background-color:inherit;
-color:#69e;
-}
-
-#tagline{
-text-align:center;
-font-size:1.2em;
-}
-
-#intro p{
-line-height:1.5em;
-}
-
-#main{
-float:left;
-width:530px;
-margin-right:20px;
-padding:0;
-}
-
-#main h2, .navbar {
-display:block;
-margin:30px 0 10px 0;
-padding:5px 0 5px 8px;
-background:#eee url(images/gradient2.png) repeat-x;
-color:#222;
-border-top:1px solid #ddd;
-border-right:1px solid #bbb;
-border-bottom:1px solid #bbb;
-border-left:1px solid #ddd;
-text-decoration:none;
-}
-
-#sidebar{
-width:155px;
-float:right;
-margin-top:20px;
-font-size:1em;
-line-height:1.3em;
-}
-
-#sidebar p, #sidebar .linklist {
-font-size:0.9em;
-}
-
-#sidebar ul.linklist {
-list-style-type: none;
-margin: 0px;
-padding: 5px 0px 5px 8px;
-}
-
-#sidebar #menu ul, #sidebar #submenu ul {
-list-style-type: none;
-margin: 0px;
-padding: 0px;
-}
-
-ul li ul li {
-    margin-left: -2em;
-    padding-left: 0;
-}
-
-#sidebar #menu li, .sidelink, #sidebar #submenu li, #sidebar #submenu li {
-display:block;
-width:140px;
-margin:3px 10px 2px 0;
-padding:5px 0 5px 8px;
-font-size:1.1em;
-font-weight:bold;
-text-align:left;
-background:#eee url(images/gradient1.png) repeat-x;
-color:#26c;
-border-top:1px solid #ddd;
-border-right:1px solid #bbb;
-border-bottom:1px solid #bbb;
-border-left:1px solid #ddd;
-}
-
-#sidebar #menu a:hover {
-    text-decoration: none;
-}
-
-#sidebar #menu li.webgen-menu-submenu-inhierarchy, .menuheader {
-background:#fff url(images/gradient2.png) repeat-x;
-color:#222;
-border-top:1px solid #ddd;
-border-right:1px solid #888;
-border-bottom:1px solid #888;
-border-left:1px solid #ddd;
-text-decoration:none;
-}
-
-#sidebar #menu li.webgen-menu-item-selected {
-    color: #222;
-}
-#sidebar #menu li.webgen-menu-item-selected:hover {
-    color: #222;
-    background: none;
-    border: none;
-}
-
-.menuheader {
-    font-size: 1.4em;
-    text-align: center;
-    margin-bottom: .4em;
-}
-
-#sidebar #submenu li.webgen-menu-item-selected, #sidebar #submenu li:hover {
-background: none;
-font-size: 1em: 
-}
-
-#sidebar #menu li ul li, #sidebar #submenu li ul li, #sidebar #submenu li ul li.webgen-menu-item-selected {
-display:block;
-width:130px;
-margin:3px 10px 2px 0;
-padding:0px 0 0px 8px;
-font-size:0.8em;
-font-weight:bold;
-text-align:left;
-background: none;
-color:#26c;
-border: none;
-}
-
-
-#footer{
-margin:0 auto 20px auto;
-width:760px;
-background:#fff url(images/footerbg.png) bottom left no-repeat;
-padding:0 0 5px 0;
-font-size:0.9em;
-color:#888;
-text-align:center;
-}
-
-h1,h2,h3,h4{
-margin:0 0 10px 0;
-font-weight:normal;
-}
-
-h1{
-font-size:2.8em;
-margin-top: 5px;
-margin-bottom: 5px;
-}
-
-h2{
-margin:0 0 4px 0;
-font-size:1.8em;
-}
-
-h3{
-margin:20px 0 8px 0;
-font-size:1.4em;
-}
-
-h4{
-margin:10px 0 5px 0;
-font-size:1.2em;
-}
-
-.clear{
-clear:both;
-margin:0;
-}
-
-.right{
-text-align:right;
-}
-
-.internallink{
-font-size:0.9em;
-text-align:center;
-}
-
-.block{
-padding:20px;
-background:#eee;
-color:#222;
-border:2px solid #ddd;
-margin-top: 3em;
-margin-bottom: 3em;
-margin-left: 2em;
-margin-right: 2em;
-}
-
-.warning{
-padding:20px;
-background:#fbb;
-color:#222;
-border:2px solid #eaa;
-margin-top: 3em;
-margin-bottom: 3em;
-margin-left: 2em;
-margin-right: 2em;
-
-}
-
-.credit{
-color:#888;
-background-color:inherit;
-}
-
-.hide{
-display:none;
-}
-
-pre .code{
-margin-left: 2.5em;
-}
-pre {
-margin-left: 2.5em;
-}
-code {
-    font: monospace;
-}
-
-
-/* Original open source design by Andreas Viklund - http://andreasviklund.com
-Released through OSWD.org */
-
-.navbar {
-    padding-left: 1em;
-    padding-right: 1em;
-    padding-bottom: 2em;
-}
-.previous .next {
-    margin: 1em;
-    display: inline;
-    font-size: 1.2em;
-}
-.previous {
-    float: left;
-}
-.next {
-    float: right;
-}
-
-.fullfigure {
-    text-align: center;
-}
-.figurecaption {
-    text-align: center;
-    margin-top: -1em;
-    margin-bottom: 4em;
-    margin-left: 10%;
-    margin-right: 10%;
-    background:#eee;
-    color:#222;
-    border:2px solid #ddd;
-}
-.commandline {
-    font: monospace;
-    margin-left: 1em;
-    margin-top: -.6em;
-    margin-bottom: .5em;
-}
-