]> git.e2factory.org Git - e2factory.git/commitdiff
remove outdated document
authorTobias Ulmer <tu@emlix.com>
Thu, 20 Oct 2016 16:12:01 +0000 (18:12 +0200)
committerTobias Ulmer <tu@emlix.com>
Wed, 16 Nov 2016 14:41:18 +0000 (15:41 +0100)
Signed-off-by: Tobias Ulmer <tu@emlix.com>
Coding [deleted file]

diff --git a/Coding b/Coding
deleted file mode 100644 (file)
index fb9b913..0000000
--- a/Coding
+++ /dev/null
@@ -1,40 +0,0 @@
-Error handling
- * Functions should always return:
-   * a boolean value and an error object on failure.
-   * or one or more values, or nil as the first value and an error object on
-     failure.
- * when an error occurs, an error object must be created and returned
- * error objects must be handled by the caller by
-   * passing them up
-   * ignoring them (that usually requires a comment)
-   * nesting them into another error object from the current layer
- * errors shall not be handled by calling e2lib.abort().
- * Example:
-   -- the error object from the current layer is usually named 'e'.
-   e = err.new("error copying file for")
-   -- a boolean return value is usually called 'rc'.
-   -- an error object return value is usually called 're'.
-   rc, re = f(...)
-   if not rc then
-     -- nest the error object from the f() call into our own one and return
-     return false, e:cat(re)
-   end
-
-Avoid conditional Code - minimize Code paths
- * iterate over an empty list instead of checking for nil
- * apply a default (e.g. emtpy list instead of nil) as early as possible
-   where values are optional when building up data structures
-
-Committing
- * follow the one-fix-per-commit and one-commit-per-fix policy
- * that gives us readable commits
- * do not merge, but rebase, i.e. do not use git-pull to merge your
-   stuff to the upstream branch, but rebase your commits onto the
-   upstream branch.
- * No merge commits on upstream.
-
-Submitting patches
- * send patches to e2factory-devel@lists.e2factory.org
- * use appropriate git tools if possible
-   Example:
-   $ git send-email --to e2factory-devel@lists.e2factory.org COMMITA..COMMITB