Author: paultcochrane
Date: Sun Jun 3 07:38:04 2007
New Revision: 18781
Modified:
trunk/docs/pdds/pdd00_pdd.pod
trunk/docs/pdds/pdd07_codingstd.pod
Changes in other areas also in this revision:
Modified:
trunk/docs/debug.pod
trunk/docs/gettingstarted.pod
Log:
[docs] References to developer files have now been updated to point to
docs/dev where appropriate and references to *.dev files have been replaced
with *.pod as per current usage
Modified: trunk/docs/pdds/pdd00_pdd.pod
==============================================================================
--- trunk/docs/pdds/pdd00_pdd.pod (original)
+++ trunk/docs/pdds/pdd00_pdd.pod Sun Jun 3 07:38:04 2007
@@ -21,7 +21,7 @@
The key aspects of Parrot's design are its interface to the outside world --
its feature set -- and its internal structure, both in code and in the broader
-project. Thus, PDDs descirbe Parrot's:
+project. Thus, PDDs describe Parrot's:
=over 4
@@ -48,8 +48,8 @@
PDDS B<should not> discuss the implementation details or trade-offs, unless
they absolutely have to. Such implementation documentation should go in the
-relevant F<*.dev> file. On the other hand, PDDs B<should> document design
-trade-offs, i.e. the paths not chosen.
+relevant F<docs/dev/*.pod> file. On the other hand, PDDs B<should> document
+design trade-offs, i.e. the paths not chosen.
These guidelines may seem fuzzy. The line between "design" and
"implementation" is a murky one. Still, please try to adhere to this design
Modified: trunk/docs/pdds/pdd07_codingstd.pod
==============================================================================
--- trunk/docs/pdds/pdd07_codingstd.pod (original)
+++ trunk/docs/pdds/pdd07_codingstd.pod Sun Jun 3 07:38:04 2007
@@ -807,7 +807,7 @@
documentation containing information on the implementation decisions associated
with the source file. (Note that this is in contrast to PDDs, which describe
design decisions). In addition, more discussive documentation can be placed in
-F<*.dev> files in the F<docs/dev> directory. This is the place for mini-essays
+F<*.pod> files in the F<docs/dev> directory. This is the place for mini-essays
on how to avoid overflows in unsigned arithmetic, or on the pros and cons of
differing hash algorithms, and why the current one was chosen, and how it
works.
@@ -898,7 +898,7 @@
schmuck trying subsequently to replace it with something 'cleaner'.
/* The loop is partially unrolled here as it makes it a lot faster.
- * See the .dev file for the full details
+ * See the file in docs/dev for the full details
*/
=item General comments
