basis/bootstrap/image/image-docs.factor

   1 USING: help.markup help.syntax io io.files ;
   2 IN: bootstrap.image
   3
   4 ARTICLE: "bootstrap.image" "Bootstrapping new images"
   5 "A new image can be built from source; this is known as " { $emphasis "bootstrap" } ". Bootstrap is a two-step process. The first stage is the creation of a bootstrap image from a running Factor instance:"
   6 { $subsection make-image }
   7 "The second bootstrapping stage is initiated by running the resulting bootstrap image:"
   8 { $code "./factor -i=boot.x86.32.image" }
   9 "This stage loads additional code, compiles all words, and dumps a final " { $snippet "factor.image" } "."
  10 $nl
  11 "The bootstrap process can be customized with command-line switches."
  12 { $see-also "runtime-cli-args" "bootstrap-cli-args" } ;
  13
  14 ABOUT: "bootstrap.image"
  15
  16 HELP: make-image
  17 { $values { "arch" "a string" } }
  18 { $description "Creates a bootstrap image from sources, where " { $snippet "architecture" } " is one of the following:"
  19 { $code "x86.32" "x86.64" "ppc" "arm" }
  20 "The new image file is written to the " { $link resource-path } " and is named " { $snippet "boot." { $emphasis "architecture" } ".image" } "." } ;