summaryrefslogtreecommitdiff
path: root/README.Python
diff options
context:
space:
mode:
authorDaniel Baumann <mail@daniel-baumann.ch>2013-11-06 09:52:45 +0100
committerDaniel Baumann <mail@daniel-baumann.ch>2013-11-06 09:52:45 +0100
commit6dc7604be708b5980372d6a500721efdcf19e293 (patch)
treec13f654f069473283dbad2200631bcede01be04c /README.Python
parentaeaaf8709e1446c76295c84876ab5d8bd267d2d7 (diff)
downloadvyos-live-build-6dc7604be708b5980372d6a500721efdcf19e293.tar.gz
vyos-live-build-6dc7604be708b5980372d6a500721efdcf19e293.zip
Adding some notes on coding style in python readme.
Diffstat (limited to 'README.Python')
-rw-r--r--README.Python13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.Python b/README.Python
index 0a1282dea..153cd8ea1 100644
--- a/README.Python
+++ b/README.Python
@@ -6,3 +6,16 @@ interconnection between them.
Once done, the newly Python sources will be shaped into modules and
subcommands properly.
+
+---
+
+Some notes on coding style:
+
+ * live-build commands should be *prefixed* with the stage:
+ chroot-includes, not includes-chroot; -> tab-completion
+
+ * directories/files in the config directory should be *suffixed* with the stage:
+ includes.chroot, not chroot.includes; -> sort-order
+
+ * cli arguments should be *suffixed* with the stage:
+ --mirror-bootstrap, not --bootstrap-mirror; -> tab-completion