basis/tools/deploy/config/editor/editor-docs.factor

   1 USING: assocs help.markup help.syntax kernel
   2 tools.deploy.config ;
   3 IN: tools.deploy.config.editor
   4
   5 ARTICLE: "deploy-config" "Deployment configuration"
   6 "The deployment configuration is a key/value mapping stored in the " { $snippet "deploy.factor" } " file in the vocabulary's directory. If this file does not exist, the default deployment configuration is used:"
   7 { $subsection default-config }
   8 "The deployment configuration can be read and written with a pair of words:"
   9 { $subsection deploy-config }
  10 { $subsection set-deploy-config }
  11 "A utility word is provided to load the configuration, change a flag, and store it back to disk:"
  12 { $subsection set-deploy-flag }
  13 "The " { $link "ui.tools.deploy" } " provides a graphical way of editing the configuration." ;
  14
  15 HELP: deploy-config
  16 { $values { "vocab" "a vocabulary specifier" } { "assoc" assoc } }
  17 { $description "Loads a vocabulary's deployment configuration from the " { $snippet "deploy.factor" } " file in the vocabulary's directory. If the file does not exist, the " { $link default-config } " is output." } ;
  18
  19 HELP: set-deploy-config
  20 { $values { "assoc" assoc } { "vocab" "a vocabulary specifier" } }
  21 { $description "Stores a vocabulary's deployment configuration to the " { $snippet "deploy.factor" } " file in the vocabulary's directory." } ;
  22
  23 HELP: set-deploy-flag
  24 { $values { "value" object } { "key" object } { "vocab" "a vocabulary specifier" } }
  25 { $description "Modifies an entry in a vocabulary's deployment configuration on disk." } ;
  26
  27 ABOUT: "deploy-config"