cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ko...@apache.org
Subject [1/2] git commit: updated refs/heads/master to 465dee0
Date Thu, 07 Nov 2013 20:23:05 GMT
Updated Branches:
  refs/heads/master 6a396a905 -> 465dee015


Removing coded documentation

This is the output of the program, the developer documentation may be a better place

-----

When developing against the CloudStack Orchestration Platform, you must following the following
rules:
API Rule: Always be prepared to handle RuntimeExceptions.

When writing APIs, you must follow these rules:
API Rule: You may think you're the greatest developer in the world but every change to the
API must be reviewed and approved.
API Rule: Every API must have unit tests written against it.  And not it's unit tests
API Rule:

-----

Signed-off-by: Laszlo Hornyak <laszlo.hornyak@gmail.com>


Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/465dee01
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/465dee01
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/465dee01

Branch: refs/heads/master
Commit: 465dee01594c5683e9c5bb8a0a69b20864ba030e
Parents: 336eb48
Author: Laszlo Hornyak <laszlo.hornyak@gmail.com>
Authored: Fri Oct 11 20:34:17 2013 +0200
Committer: Laszlo Hornyak <laszlo.hornyak@gmail.com>
Committed: Thu Nov 7 21:18:52 2013 +0100

----------------------------------------------------------------------
 .../src/org/apache/cloudstack/engine/Rules.java | 73 --------------------
 1 file changed, 73 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cloudstack/blob/465dee01/engine/api/src/org/apache/cloudstack/engine/Rules.java
----------------------------------------------------------------------
diff --git a/engine/api/src/org/apache/cloudstack/engine/Rules.java b/engine/api/src/org/apache/cloudstack/engine/Rules.java
deleted file mode 100755
index 04b17a2..0000000
--- a/engine/api/src/org/apache/cloudstack/engine/Rules.java
+++ /dev/null
@@ -1,73 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-package org.apache.cloudstack.engine;
-
-import java.util.ArrayList;
-import java.util.List;
-
-
-/**
- * Rules specifies all rules about developing and using CloudStack Orchestration
- * Platforms APIs.  This class is not actually used in CloudStack Orchestration
- * Platform but must be read by all who wants to use and develop against
- * CloudStack Orchestration Platform.
- * 
- * Make sure to make changes here when there are changes to how the APIs should 
- * be used and developed. 
- * 
- * Changes to this class must be approved by the maintainer of this project.
- *
- */
-public class Rules {
-    public static List<String> whenUsing() {
-        List<String> rules = new ArrayList<String>();
-        rules.add("Always be prepared to handle RuntimeExceptions.");
-        return rules;
-    }
-
-    public static List<String> whenWritingNewApis() {
-        List<String> rules = new ArrayList<String>();
-        rules.add("You may think you're the greatest developer in the " +
-                "world but every change to the API must be reviewed and approved. ");
-        rules.add("Every API must have unit tests written against it.  And not it's unit
tests");
-        rules.add("");
-
-
-        return rules;
-    }
-
-    private static void printRule(String rule) {
-        System.out.print("API Rule: ");
-        System.out.println(rule);
-    }
-
-    public static void main(String[] args) {
-        System.out.println("When developing against the CloudStack Orchestration Platform,
you must following the following rules:");
-        for (String rule : whenUsing()) {
-            printRule(rule);
-        }
-        System.out.println("");
-        System.out.println("When writing APIs, you must follow these rules:");
-        for (String rule : whenWritingNewApis()) {
-            printRule(rule);
-        }
-    }
-
-}
-


Mime
View raw message