summaryrefslogtreecommitdiffstats
path: root/doc/coding/coding-style
diff options
context:
space:
mode:
Diffstat (limited to 'doc/coding/coding-style')
-rw-r--r--doc/coding/coding-style27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/coding/coding-style b/doc/coding/coding-style
new file mode 100644
index 00000000..b3658ef8
--- /dev/null
+++ b/doc/coding/coding-style
@@ -0,0 +1,27 @@
+Some guidelines
+
+-- 1. Leading Tabs, no spaces.
+.vimrc:
+set noexpandtab
+set tabstop=<spaces to display per tab>
+set autoindent
+
+If you want to see leading/trailing spaces:
+highlight ExtraWhitespace ctermbg=red guibg=red
+match ExtraWhitespace /^\t*\zs \+\|\s\+\%#\@<!$/
+
+
+-- 2. ALL_CAPS_VARIABLE_NAMES
+Variable names should be in caps. You can use lowercase
+in for statements, like "for i in $SOME_STUFF; do"
+Some old scripts haven't been updated yet....
+
+
+-- 3. "do", "then" ... on the same line
+for i in x; do
+if [ xyz ]; then
+
+
+-- 4.
+
+