[ Home | Main Table Of Contents | Table Of Contents | Keyword Index ]

kettle_introduction(n) 1 doc "Kettle - The Quick Brew System"

Name

kettle_introduction - Kettle - Introduction to Kettle

Table Of Contents

Synopsis

  • package require Tcl 8.5

Description

Welcome to Kettle, a set of packages providing support for writing build code for Tcl packages. Kettle is a system to make building Tcl packages quick and easy. More importantly, possibly, to make writing the build system for Tcl packages easy.

As such kettle is several things:

  1. A DSL helping you to write build systems for your packages.

  2. A package implementing this DSL.

  3. An application which can serve as the interpreter for a build file containing commands in the above DSL.

All of these will be explained in the documentation, although not everything is for everybody. I.e. a user of the DSL requires a different set of knowledge than a developer working on extending kettle's DSL, etc.

Related Documents

  1. Kettle - License.

  2. Kettle - How To Get The Sources.

  3. Kettle - The Installer's Guide.

  4. Kettle - The Developer's Guide.

System Architecture

The image below provides a basic overview of the system's architecture, with a package's custom build file at the top, using DSL commands from core layer, under the mediation of the kettle application.

architecture

The manpages relevant to a user of kettle, i.e. to a package developer wishing to use it as the build system for her code are:

  1. Kettle - Application - Build Interpreter

  2. Kettle - Build Declarations

  3. Kettle - Testsuite support

For the developers and maintainers of kettle, and power users wishing to extend the system to handle their custom circumstances, we additionally have:

  1. Kettle - The Developer's Guide

  2. Kettle - Core

Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such at the Kettle Tracker. Please also report any ideas for enhancements you may have for either package and/or documentation.

Keywords

build tea

Category

Build support