doc/kmkdocs.c

   1 /* $Id$
   2  *
   3  * kmk design and documentation.
   4  *
   5  * Copyright (c) 2002 knut st. osmundsen <bird@anduin.net>
   6  *
   7  *
   8  * This file is part of kBuild.
   9  *
  10  * kBuild is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU Lesser General Public License as published
  12  * by the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * kBuild is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with kBuild; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  *
  24  */
  25
  26 /** @design             kmk
  27  *
  28  * kmk is the make file interpreter and executer in kBuild. It is based on
  29  * FreeBSD make but some changes have been made.
  30  *
  31  *
  32  *
  33  * @subsection          Differences From BSD Make
  34  *
  35  * The main difference is that kmk doesn't make use of an external shell to execute
  36  * commands. It uses it's internal micro shell. This has a number of advantages
  37  * when it comes to portability. It also speeds up the execution a little bit.
  38  *
  39  * The other important difference is default makefile names and order. The names
  40  * and order is as follows:
  41  * <ol>
  42  *     <li>makefile.kmk
  43  *     <li>Makefile.kmk
  44  *     <li>makefile
  45  *     <li>Makefile
  46  * </ol>
  47  *
  48  *
  49  *
  50  *
  51  */