From: Tobias Ulmer <tu@emlix.com>
Date: Fri, 1 Feb 2013 17:49:34 +0000 (+0100)
Subject: Remove e2option.documentation
X-Git-Tag: e2factory-2.3.13rc1~28
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=d2e0439c6e5f7e7d0567e0ee0102e3168ba3da41;p=e2factory.git

Remove e2option.documentation

Signed-off-by: Tobias Ulmer <tu@emlix.com>
---

diff --git a/global/e2-create-project.lua b/global/e2-create-project.lua
index 8f9e7c0..99932e2 100644
--- a/global/e2-create-project.lua
+++ b/global/e2-create-project.lua
@@ -37,15 +37,6 @@ require("buildconfig")
 
 e2lib.init()
 
-local doc = [[
-usage: e2-create-project [<option> ...] [<server>:]<location>
-
-Create a new project and store it on <server> in <location>.
-<server> defaults to '%s'.
-]]
-e2option.documentation = string.format(doc,
-e2lib.globals.default_projects_server)
-
 local opts, arguments = e2option.parse(arg)
 local rc, e = e2lib.read_global_config()
 if not rc then
diff --git a/global/e2-fetch-project.lua b/global/e2-fetch-project.lua
index 0fbf2a7..4640b36 100644
--- a/global/e2-fetch-project.lua
+++ b/global/e2-fetch-project.lua
@@ -36,17 +36,8 @@ local err = require("err")
 require("buildconfig")
 
 e2lib.init()
-local e = err.new("fetching project failed")
-local doc = [[
-usage: e2-fetch-project [<option> ...] [<server>:]<location> [<destination>]
-
-fetch the project located in server:location to a directory given in
-<destination>.
-<server> defaults to '%s'.
-]]
-e2option.documentation = string.format(doc,
-e2lib.globals.default_projects_server)
 
+local e = err.new("fetching project failed")
 e2option.option("branch", "retrieve a specific project branch")
 e2option.option("tag", "retrieve a specific project tag")
 
diff --git a/global/e2-install-e2.lua b/global/e2-install-e2.lua
index 77f622c..cfd02ab 100644
--- a/global/e2-install-e2.lua
+++ b/global/e2-install-e2.lua
@@ -36,12 +36,6 @@ require("buildconfig")
 
 e2lib.init()
 
-e2option.documentation = [[
-usage: e2-install-e2 [OPTION ...]
-
-Installs local tools in project environment.
-]]
-
 local opts, arguments = e2option.parse(arg)
 
 local root = e2lib.locate_project_root()
diff --git a/global/e2.lua b/global/e2.lua
index 0fbca62..00dd08f 100644
--- a/global/e2.lua
+++ b/global/e2.lua
@@ -35,15 +35,6 @@ require("e2util")
 
 e2lib.init()
 
-e2option.documentation = [[
-usage: e2 OPTION ...
-e2 COMMAND ARGUMENT ...
-
-"e2" is a wrapper script for invoking e2 commands. Any e2 commands called will
-be redirected either to the project-local or the global installation, depend‐
-ing on whether the invocation took place inside or outside a project tree.
-]]
-
 e2option.flag("prefix", "print installation prefix",
 function()
     print(buildconfig.PREFIX)
diff --git a/local/e2-build.lua b/local/e2-build.lua
index d77f653..2d7e817 100644
--- a/local/e2-build.lua
+++ b/local/e2-build.lua
@@ -42,12 +42,6 @@ if not info then
     e2lib.abort(re)
 end
 
-e2option.documentation = [[
-usage: e2-build [<option> | <result> ...]
-
-build results from repository or local sources.
-]]
-
 e2option.flag("all", "build all results (default unless for working copy)")
 policy.register_commandline_options()
 e2option.flag("branch-mode", "build selected results in branch mode")
diff --git a/local/e2-cf.lua b/local/e2-cf.lua
index f3da646..e9718b3 100644
--- a/local/e2-cf.lua
+++ b/local/e2-cf.lua
@@ -39,25 +39,6 @@ if not info then
     e2lib.abort(re)
 end
 
-e2option.documentation = [[
-usage: e2 cf <command> ...
-
-commands:
-newresult       <name>
-newsource       <name> <scm>
-editresult      <name>
-editbuildscript <name>
-editsource      <name>
-
-Commands starting with 'edit' can be abbreviated by using e...
-Commands starting with 'new' can be abbreviated by using n...
-Commands can be shortened as long as they remain unambiguous
-
-e.g.: eb <name> is equivalent to editbuildscript <name>
-
-modify and create configuration files
-]]
-
 local opts, arguments = e2option.parse(arg)
 
 -- initialize some basics in the info structure without actually loading
diff --git a/local/e2-dlist.lua b/local/e2-dlist.lua
index 8e2f25a..f9669ff 100644
--- a/local/e2-dlist.lua
+++ b/local/e2-dlist.lua
@@ -38,12 +38,6 @@ if not info then
     e2lib.abort(re)
 end
 
-e2option.documentation = [[
-usage: e2-dlist [<option> | <result> ...]
-
-for the given result show those results which it depends on
-]]
-
 e2option.flag("recursive", "show indirect dependencies, too")
 local opts, arguments = e2option.parse(arg)
 
diff --git a/local/e2-dsort.lua b/local/e2-dsort.lua
index 7dfffc3..73ed7b9 100644
--- a/local/e2-dsort.lua
+++ b/local/e2-dsort.lua
@@ -38,12 +38,6 @@ if not info then
     e2lib.abort(re)
 end
 
-e2option.documentation = [[
-usage: e2-dsort
-
-lists all results sorted by dependency
-]]
-
 e2option.parse(arg)
 
 info, re = e2tool.collect_project_info(info)
diff --git a/local/e2-fetch-sources.lua b/local/e2-fetch-sources.lua
index 8e9f286..f589a1f 100644
--- a/local/e2-fetch-sources.lua
+++ b/local/e2-fetch-sources.lua
@@ -42,26 +42,6 @@ if not info then
     e2lib.abort(re)
 end
 
-e2option.documentation = [[
-usage: e2-fetch-sources <source> ...
-
-fetch all sources for a project, provided they are not fetched yet.
-up-to-dateness is not checked for sources which are already fetched.
-]]
-
--- --all (--scm)
--- --source    select sources by source names
--- --result    select sources by result names
--- --chroot    select chroot files
--- --files     select files sources
--- --scm       select sources using scm systems
---  --git
---  --cvs
---  --svn
---
--- --fetch, --cache  fetch selected sources
--- --update          update selected sources
-
 local e = err.new()
 
 e2option.flag("all", "select all sources, even files sources")
diff --git a/local/e2-ls-project.lua b/local/e2-ls-project.lua
index 10cb4af..05c498d 100644
--- a/local/e2-ls-project.lua
+++ b/local/e2-ls-project.lua
@@ -43,12 +43,6 @@ if not info then
     e2lib.abort(re)
 end
 
-e2option.documentation = [[
-usage: e2-ls-project [<result> ...]
-
-show project information
-]]
-
 policy.register_commandline_options()
 e2option.flag("dot", "generate dot(1) graph")
 e2option.flag("dot-sources", "generate dot(1) graph with sources included")
diff --git a/local/e2-new-source.lua b/local/e2-new-source.lua
index f99769f..e769d94 100644
--- a/local/e2-new-source.lua
+++ b/local/e2-new-source.lua
@@ -47,24 +47,6 @@ if not info then
     e2lib.abort(re)
 end
 
-e2option.documentation = [[
-usage: e2-new-source --git [--server <server>] <name>
-       e2-new-source --files [--no-checksum]
-		[<server>:]<location> <source_file_url> [<checksum_file_url>]
-
- Put new source onto an existing server.
-
- --git
- Put a repository named <name> into the projects' 'git/' directory on
- the server, i.e. <server>/<project>/git/<name>.git
- The server defaults to the default repository server, and the <project>
- part is the project location relative to the projects server.
-
- --files
- Put a new file onto the server.
- Server defaults to 'upstream'
-]]
-
 e2option.flag("git", "create a git repository")
 e2option.flag("files", "create a new file on a files server")
 e2option.option("server", "specify server")
diff --git a/local/e2-playground.lua b/local/e2-playground.lua
index 0635677..34b61ec 100644
--- a/local/e2-playground.lua
+++ b/local/e2-playground.lua
@@ -46,11 +46,6 @@ end
 local e = err.new("entering playground failed")
 local rc, re
 
-e2option.documentation = [[
-usage: e2-playground [<options> ...] <result>
-
-Jump into chroot(1) environment for specified result, if it exists.
-]]
 e2option.option("command","execute command in chroot")
 e2option.flag("runinit","run init files automatically")
 e2option.flag("showpath", "prints the path of the build directory inside the chroot to stdout" )