1.0.46.43: fix sb-introspect on non-threaded builds

[sbcl.git] / STYLE

diff --git a/STYLE b/STYLE
index 2d2cfb3..2c6f6f3 100644 (file)
--- a/STYLE
+++ b/STYLE
@@ -1,9 +1,45 @@
+SBCL Style Guide
+
+  (This is not a most actively maintained file, but recommended
+  reading anyways.)
+
+Patch Submissions
+=================
+
+Preferred patch format is output from "git format-patch", including
+the commit message. The commit message should explain the why and how
+of the change.
+
+Please include test-cases in your patch if at all possible.
+
+Please format your submission for ease of reading: unless the change
+is whitespace only, avoid re-indenting code you are not touching, etc.
+Unless your patch is large and best understood as a series of
+sequential changes, please send it in as single patch file.
+
+If your patch includes algorithmic changes, explain them. If your
+patch uses a published algorithm, please include a link to the paper.
+We aren't always as well-educated as we'd like to...
+
+Ready-to-apply patches should be submitted via Launchpad: please add
+the tag "review" to the associated bug.
+
+Patches requiring more widespread discussion and feedback should be
+sent to the sbcl-devel mailing list.
+
+If you have any questions, feel free to ask them on sbcl-devel.
+
+Coding Style
+============
+
+See also PRINCIPLES and TLA files.
+
 Most of the style hints in the Lisp FAQ apply.
 
-When porting the system, I would really prefer code which factors
-dependencies into a set of interface functions and constants and
-includes implementations of the interface for the different systems.
-Patches which require conditional compilation (like all the old
+When porting code we prefer code which factors dependencies into a set
+of interface functions and constants and includes implementations of
+the interface for the different systems. Patches which require
+conditional compilation (like all the old
 #T+HPUX or #T-X86 tests in the sources inherited from CMUCL) might be
 accepted if they're simple, in hopes of factoring out the differences
 more cleanly later, but even if accepted, such code may not be
@@ -94,6 +130,6 @@ which are not good examples to follow:
     (DEFUN CL:CADDDR (..) ..) as reminders that they're required by
     ANSI and can't be deleted no matter how obscure and useless some
     of them might look.:-)
-Most of these are common in the code inherited from CMUCL. I've
+Most of these are common in the code inherited from CMUCL. We've
 eliminated them in some places, but there's a *lot* of code inherited
 from CMUCL..