From: Tobias Ulmer Date: Thu, 20 Oct 2016 16:12:01 +0000 (+0200) Subject: remove outdated document X-Git-Tag: e2factory-2.3.15rc1~67 X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=746ad621566e2f11043419bc01d45ade8a247bed;p=e2factory.git remove outdated document Signed-off-by: Tobias Ulmer --- diff --git a/Coding b/Coding deleted file mode 100644 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