|
@@ -1,52 +0,0 @@
|
1
|
|
-
|
2
|
|
-UI
|
3
|
|
---
|
4
|
|
-
|
5
|
|
-* Heavily prefer unix filter UI.
|
6
|
|
-
|
7
|
|
- If you can't do it with filtering, it could mean you should
|
8
|
|
- split your function anyway.
|
9
|
|
-
|
10
|
|
-* Even function can use dash options and even `usagef()`.
|
11
|
|
-
|
12
|
|
-* Reserved options are
|
13
|
|
-
|
14
|
|
- * `-q|--quiet`, to turn off verbosity,
|
15
|
|
- * `-v|--verbose`, to turn on verbosity,
|
16
|
|
- * and `-d|--debug` to turn on debug output (stderr).
|
17
|
|
-
|
18
|
|
-* Do not `think()` in functions.
|
19
|
|
-
|
20
|
|
-* Preferred capitalization in messages is:
|
21
|
|
-
|
22
|
|
- * all small for libs (debug/warn/die)
|
23
|
|
-
|
24
|
|
- * First cap for scripts
|
25
|
|
-
|
26
|
|
-* Message width:
|
27
|
|
-
|
28
|
|
- * think/warn/die: try hard to never exceed 72
|
29
|
|
-
|
30
|
|
- * debug: do what you must
|
31
|
|
-
|
32
|
|
- * always try to split message to fixed part, colon and *before* colon and
|
33
|
|
- the "data" part after the colon, e.g.:
|
34
|
|
-
|
35
|
|
- file missing: /var/run/media/somebody/some-medium/some-long/path
|
36
|
|
-
|
37
|
|
- instead of:
|
38
|
|
-
|
39
|
|
- file /var/run/media/somebody/some-medium/some-long/path is missing
|
40
|
|
-
|
41
|
|
- (even if you think that it will be short)
|
42
|
|
-
|
43
|
|
-
|
44
|
|
-
|
45
|
|
-
|
46
|
|
-PRINCIPLES
|
47
|
|
-----------
|
48
|
|
-
|
49
|
|
-Be smart but honest: if you can default, default, otherwise be honest = fail
|
50
|
|
-
|
51
|
|
-Don't talk. `think()` instead.
|
52
|
|
-
|