[svnbook commit] r2709 - trunk/src/en

[sussman]

Author: sussman
Date: Mon Feb 26 13:06:56 2007
New Revision: 2709

Modified:
   trunk/src/en/HACKING

Log:
* src/en/HACKING:  add our rules about abbreviating subcommands and options.

Modified: trunk/src/en/HACKING
==============================================================================
--- trunk/src/en/HACKING	(original)
+++ trunk/src/en/HACKING	Mon Feb 26 13:06:56 2007
@@ -110,6 +110,25 @@
 
 ===========================================================================
 
+==================
+Abbreviation Rules
+==================
+
+
+- Subcommand names: we always use long names of subcommands,
+  e.g. "checkout", not "co".  This goes for both prose and examples.
+
+- Option names:
+
+    - For prose, always identify an option by *both* its long and
+      short name, e.g. "use the --revision (-r) option to do blah..."
+
+    - For examples, use the short version, so as to be more realistic
+      and get users comfortable with the abbreviations.
+
+
+===========================================================================
+
 =============
 Miscellaneous
 =============