summaryrefslogtreecommitdiff
path: root/RULES
diff options
context:
space:
mode:
authorMyungJoo Ham <myungjoo.ham@samsung.com>2017-02-20 17:53:25 +0900
committerMyungJoo Ham <myungjoo.ham@samsung.com>2017-02-20 17:53:25 +0900
commit272cfc5eadd79c66f44e4265ade94d6f70682853 (patch)
tree2592fc64d6d3e0999548841470492a0a88d0c922 /RULES
parent2b883c417181265080068cd3118532f2df713ee1 (diff)
downloadbuilding-blocks-272cfc5eadd79c66f44e4265ade94d6f70682853.tar.gz
building-blocks-272cfc5eadd79c66f44e4265ade94d6f70682853.tar.bz2
building-blocks-272cfc5eadd79c66f44e4265ade94d6f70682853.zip
Add MAINTAINERS/RULES
Signed-off-by: MyungJoo Ham <myungjoo.ham@samsung.com>
Diffstat (limited to 'RULES')
-rw-r--r--RULES65
1 files changed, 65 insertions, 0 deletions
diff --git a/RULES b/RULES
new file mode 100644
index 0000000..7ca772e
--- /dev/null
+++ b/RULES
@@ -0,0 +1,65 @@
+===========================================================================
+ 1. Naming Rules
+===========================================================================
+
+1-1. "building-blocks" should be the first prefix.
+
+1-2. The top-single block name is "building-blocks"
+
+1-3. Level prefix = "root" | "sub1" | "sub2"
+
+1-4. Except for the top-single block, Level prfix follows
+ the first prefix.
+ E.g., "building-blocks-sub1-..."
+
+1-5. For "root" building blocks, the naming rule is:
+ [first prefix = "building-blocks"]-[level prefix = "root"]-[NAME]
+ E.g., "building-blocks-root-UI"
+
+1-6. For "sub1" building blocks, which has a "root" building block, "ROOTNAME" as its parent, the naming rule is:
+ [first prefix]-[level prefix = "sub1"]-[root name = "ROOTNAME"]-[NAME]
+ E.g., "building-blocks-sub1-UI-wayland"
+
+1-7. For "sub2" building blocks, which has a "sub1" building block, "SUB1NAME" as its parent, the naming rule is:
+ (SUB1NAME has ROOTNAME as its parent)
+ [first prefix]-[level prefix = "sub2"]-[root name = "ROOTNAME"]-[sub1 name = "SUB1NAME"]-[NAME]
+ E.g., "building-blocks-sub2-UI-wayland-core"
+
+1-8. In order to implement "radio-button" UI (choose only one), the block name starts with "chooseonlyone_"
+ E.g., "building-blocks-root-chooseonlyone_Kernel"
+
+
+
+===========================================================================
+ 2. Relations between blocks
+===========================================================================
+
+2-1. Top block (building-blocks) lists all root-level blocks
+ Lists with Suggests (optional) and Requires (mandatory)
+
+2-2. A parent block lists all of its direct child blocks (no grandchild listed)
+ Lists with Suggests (optional) and Requires (mandatory)
+
+2-3. A child block cannot have multiple parents.
+
+2-4. Conflict may be defined between blocks.
+ However, you need to get consents from all related stake-holders.
+
+2-6. There cannot be any other relations defined between blocks.
+
+
+
+===========================================================================
+ 3. Relations between a block and (non-block) packages
+===========================================================================
+
+3-1. A block may include non-block (individual) packages with Requires (mandatory) and Suggests (optional)
+
+3-2. A package (not block) can exist in multiple blocks.
+
+3-3. A package may be not included in any of the blocks
+ TIC UI will list such packages in "MISC" section.
+
+
+
+