[pypy-svn] r12613 - pypy/dist/pypy/documentation

hpk at codespeak.net hpk at codespeak.net
Fri May 20 12:43:44 CEST 2005


Author: hpk
Date: Fri May 20 12:43:44 2005
New Revision: 12613

Added:
   pypy/dist/pypy/documentation/extradoc.txt
      - copied, changed from r12610, pypy/dist/pypy/documentation/index.txt
Modified:
   pypy/dist/pypy/documentation/getting_started.txt
   pypy/dist/pypy/documentation/index.txt
Log:
issue65 resolved 
issue37 testing 

- moved the directory reference to the main 'doc' page 

- created a new 'extradoc' document listing talks 
  and related projects and linked that document
  from the main doc page. 

- refactored getting_started.txt 
    - refers to the directory reference 

    - second too large chapter is split (i intend 
      to do a bit of more work on this and then 
      close issue37 as well) 



Copied: pypy/dist/pypy/documentation/extradoc.txt (from r12610, pypy/dist/pypy/documentation/index.txt)
==============================================================================
--- pypy/dist/pypy/documentation/index.txt	(original)
+++ pypy/dist/pypy/documentation/extradoc.txt	Fri May 20 12:43:44 2005
@@ -1,38 +1,7 @@
 =================================================
-PyPy - a Python_ implementation written in Python 
+PyPy - talks and related projects 
 =================================================
 
-.. _Python: http://www.python.org/dev/doc/maint24/ref/ref.html
-
-architecture_ gives a complete view of PyPy's basic design. 
-
-`getting started`_ provides hands-on instructions 
-including a two-liner to run PyPy on your system. 
-
-`coding guide`_ helps you to write code for PyPy. 
-
-`object spaces`_ discusses the object space interface 
-and several implementations. 
-
-`translation`_ offers the beginnings of documentation 
-about our low level code generator backends. 
-
-`compliance test status`_ shows outcome information 
-about recent runs of CPython's regression tests against PyPy. 
-
-`license`_ tells you that basically all of PyPy is licensed 
-under the OSI-approved very liberal MIT-license. 
-
-.. _`license`: http://codespeak.net/svn/pypy/dist/LICENSE 
-.. _`compliance test status`: http://codespeak.net/~hpk/pypy-testresult/
-.. _`object spaces`: objspace.html 
-.. _`translation`: translation.html 
-.. _`coding guide`: coding-guide.html 
-.. _`architecture`: architecture.html 
-.. _`revision report`: http://codespeak.net/pypy/rev/current 
-.. _`getting started`: getting_started.html 
-.. _`theory`: theory.html
-
 Talks and Presentations 
 ----------------------------------
 

Modified: pypy/dist/pypy/documentation/getting_started.txt
==============================================================================
--- pypy/dist/pypy/documentation/getting_started.txt	(original)
+++ pypy/dist/pypy/documentation/getting_started.txt	Fri May 20 12:43:44 2005
@@ -63,6 +63,7 @@
 for some guidance on how to continue. 
 
 .. _`help on installing subversion`: svn-help.html
+.. _subversion: svn-help.html
 
 Understanding PyPy's architecture
 ---------------------------------
@@ -374,11 +375,12 @@
 .. _`start reading sources`: 
    
 Where to start reading the sources
----------------------------------- 
+================================== 
 
 PyPy is made from parts that are relatively independent from each other.
 You should start looking at the part that attracts you most (all parts are
-relative to the PyPy toplevel directory):
+relative to the PyPy toplevel directory).  You may look at our `directory reference`_ 
+or start off at one of the following points:
 
 *  `pypy/interpreter`_ contains the basic interpreter: bytecode dispatcher
    in pyopcode.py_, frame and code objects in eval.py_ and pyframe.py_,
@@ -405,21 +407,6 @@
    `pypy/translator/annrpython.py`_.
 
 
-To learn more
-------------- 
-
-* To learn more about PyPy and its development process,  
-  read around in the documentation_ and consider 
-  subscribing to the `mailing lists`_ (or simply
-  read the archives online) 
-  
-* show up on irc.freenode.net:6667, channel #pypy and ask
-  questions.  The logs of the channel can be found at 
-  http://nimrod.terra-link.net/pypy/_.
-
-* To help PyPy become Python-the-next-generation, you 
-  are invited to participate in its development. 
-   
 .. _optionaltool: 
 
 Additional Tools for running (and hacking) PyPy 
@@ -513,104 +500,22 @@
 .. _unit tests:             http://codespeak.net/pypy/index.cgi?doc/testdesign.html
 .. _bug reports:            https://codespeak.net/issue/pypy-dev/
 
+.. _`directory reference`: index.html#directory-reference
 
-.. _`directory reference`: 
-
-PyPy directory reference 
-======================================================
-
-Here is a fully referenced alphabetical two-level deep 
-directory overview of PyPy: 
-
-============================   =========================================== 
-Directory                      explanation/links
-============================   =========================================== 
-`annotation/`_                 `type inferencing code`_ for `RPython`_ programs 
-
-`documentation/`_              text versions of PyPy `documentation`_ files shown on the website 
-
-`documentation/revreport/`_    the source code for the `revision report`_ 
-
-`documentation/website/`_      text versions of the navigation webpages 
-
-`interpreter/`_                bytecode interpreter and related objects (frames, functions, modules,...) 
-
-`lib/`_                        PyPy's wholesale reimplementations of CPython modules_
-
-`lib/test2/`_                  tests running at interp-level against the reimplementations 
-
-`module/`_                     contains `mixed modules`_ implementing core modules with 
-                               both application and interpreter level code 
-
-`module/_sre_pypy/`_           an experimental approach wrapping CPython's ``_sre`` module 
-                               without using faking 
-
-`module/__builtin__/`_         full implementation of CPython's ``__builtin__`` module. 
-
-`module/parser/`_              parser package from Jonathan David Riehl's `basil`_ package
-
-`module/recparser/`_           parser package from Logilab 
-
-`module/sys/`_                 implementation of CPython's ``sys`` module.  
+To learn more / get in contact
+============================== 
 
-`objspace/`_                   `object space`_ implementations
-
-`objspace/trace.py`_           the `trace object space`_ monitoring bytecode and space operations
-
-`objspace/thunk.py`_           the `thunk object space`_, providing unique object features 
-
-`objspace/flow/`_              the FlowObjSpace_ implementing `abstract interpretation`
-
-`objspace/std/`_               the StdObjSpace_ implementing CPython's objects and types
-
-`rpython/`_                    the `RPython Typer`_ 
-
-`tool/`_                       various utilities and hacks used from various places 
-
-`tool/pytest/`_                support code for our `testing methods`_
-
-`tool/tb_server/`_             a somewhat outdated http-server for presenting 
-                               tracebacks in a helpful manner 
-
-`translator/`_                 translation_ backends and support code
-
-`translator/genc/`_            the `GenC backend`_ producing a CPython C-extension 
-                               module from a given RPython program. 
-
-`translator/java/`_            experimental code to utilize Java for annotation 
-
-`translator/llvm/`_            contains the `LLVM backend`_ producing LLVM assembler 
-                               from fully annotated RPython programs 
-
-`translator/tool/`_            helper tools for translation 
-
-``*/test/``                    many directories have a test subdirectory containing test 
-                               modules (see `Testing in PyPy`_) 
-
-``_cache/``                    holds cache files from internally translating application 
-                               level to interpreterlevel code.  (XXXM0.5 insert link here 
-                               when geninterp documentation is there). 
-============================   =========================================== 
-
-.. _`Testing in PyPy`: coding-guide.html#testing-in-pypy 
-.. _`mixed modules`: coding-guide.html#mixed-modules 
-.. _`modules`: coding-guide.html#modules 
-.. _`basil`: http://people.cs.uchicago.edu/~jriehl/BasilTalk.pdf
-.. _`object space`: objspace.html
-.. _FlowObjSpace: objspace.html#the-flow-object-space 
-.. _`trace object space`: objspace.html#the-trace-object-space 
-.. _`thunk object space`: objspace.html#the-thunk-object-space 
-.. _StdObjSpace: objspace.html#the-standard-object-space 
-.. _`abstract interpretation`: theory.html#abstract-interpretation
-.. _`rpython`: coding-guide.html#rpython 
-.. _`type inferencing code`: translation.html#the-annotation-pass 
-.. _`RPython Typer`: translation.html#rpython-typer 
-.. _`testing methods`: coding-guide.html#testing-in-pypy
-.. _`translation`: translation.html 
-.. _`GenC backend`: translation.html#genc 
-.. _`LLVM backend`: translation.html#llvm 
-.. _`revision report`: http://codespeak.net/pypy/rev/current 
+* To learn more about PyPy and its development process,  
+  read around in the documentation_ and consider 
+  subscribing to the `mailing lists`_ (or simply
+  read the archives online) 
+  
+* show up on irc.freenode.net:6667, channel #pypy and ask
+  questions.  The logs of the channel can be found at 
+  http://nimrod.terra-link.net/pypy/
 
-.. _subversion: svn-help.html
+* To help PyPy become Python-the-next-generation, you 
+  are invited to participate in its development. 
+   
 
 .. include:: _ref.txt

Modified: pypy/dist/pypy/documentation/index.txt
==============================================================================
--- pypy/dist/pypy/documentation/index.txt	(original)
+++ pypy/dist/pypy/documentation/index.txt	Fri May 20 12:43:44 2005
@@ -17,12 +17,16 @@
 `translation`_ offers the beginnings of documentation 
 about our low level code generator backends. 
 
+`talks and related projects`_ lists presentations 
+and related projects. 
+
 `compliance test status`_ shows outcome information 
 about recent runs of CPython's regression tests against PyPy. 
 
 `license`_ tells you that basically all of PyPy is licensed 
 under the OSI-approved very liberal MIT-license. 
 
+.. _`talks and related projects`: extradoc.html
 .. _`license`: http://codespeak.net/svn/pypy/dist/LICENSE 
 .. _`compliance test status`: http://codespeak.net/~hpk/pypy-testresult/
 .. _`object spaces`: objspace.html 
@@ -33,64 +37,104 @@
 .. _`getting started`: getting_started.html 
 .. _`theory`: theory.html
 
-Talks and Presentations 
-----------------------------------
 
-* oscon2003-paper_ an early paper presented at Oscon 2003 describing 
-  what the PyPy project is about and why you should care. 
+.. _`directory reference`: 
+
+PyPy directory cross-reference 
+======================================================
+
+Here is a fully referenced alphabetical two-level deep 
+directory overview of PyPy: 
+
+============================   =========================================== 
+Directory                      explanation/links
+============================   =========================================== 
+`annotation/`_                 `type inferencing code`_ for `RPython`_ programs 
+
+`documentation/`_              text versions of PyPy `documentation`_ files shown on the website 
+
+`documentation/revreport/`_    the source code for the `revision report`_ 
+
+`documentation/website/`_      text versions of the navigation webpages 
+
+`interpreter/`_                bytecode interpreter and related objects (frames, functions, modules,...) 
+
+`lib/`_                        PyPy's wholesale reimplementations of CPython modules_
+
+`lib/test2/`_                  tests running at interp-level against the reimplementations 
+
+`module/`_                     contains `mixed modules`_ implementing core modules with 
+                               both application and interpreter level code 
+
+`module/_sre_pypy/`_           an experimental approach wrapping CPython's ``_sre`` module 
+                               without using faking 
+
+`module/__builtin__/`_         full implementation of CPython's ``__builtin__`` module. 
+
+`module/parser/`_              parser package from Jonathan David Riehl's `basil`_ package
+
+`module/recparser/`_           parser package from Logilab 
+
+`module/sys/`_                 implementation of CPython's ``sys`` module.  
+
+`objspace/`_                   `object space`_ implementations
+
+`objspace/trace.py`_           the `trace object space`_ monitoring bytecode and space operations
+
+`objspace/thunk.py`_           the `thunk object space`_, providing unique object features 
+
+`objspace/flow/`_              the FlowObjSpace_ implementing `abstract interpretation`
+
+`objspace/std/`_               the StdObjSpace_ implementing CPython's objects and types
+
+`rpython/`_                    the `RPython Typer`_ 
+
+`tool/`_                       various utilities and hacks used from various places 
+
+`tool/pytest/`_                support code for our `testing methods`_
+
+`tool/tb_server/`_             a somewhat outdated http-server for presenting 
+                               tracebacks in a helpful manner 
+
+`translator/`_                 translation_ backends and support code
+
+`translator/genc/`_            the `GenC backend`_ producing a CPython C-extension 
+                               module from a given RPython program. 
+
+`translator/java/`_            experimental code to utilize Java for annotation 
+
+`translator/llvm/`_            contains the `LLVM backend`_ producing LLVM assembler 
+                               from fully annotated RPython programs 
+
+`translator/tool/`_            helper tools for translation 
+
+``*/test/``                    many directories have a test subdirectory containing test 
+                               modules (see `Testing in PyPy`_) 
+
+``_cache/``                    holds cache files from internally translating application 
+                               level to interpreterlevel code.  (XXXM0.5 insert link here 
+                               when geninterp documentation is there). 
+============================   =========================================== 
+
+.. _documentation: index.html
+.. _`Testing in PyPy`: coding-guide.html#testing-in-pypy 
+.. _`mixed modules`: coding-guide.html#mixed-modules 
+.. _`modules`: coding-guide.html#modules 
+.. _`basil`: http://people.cs.uchicago.edu/~jriehl/BasilTalk.pdf
+.. _`object space`: objspace.html
+.. _FlowObjSpace: objspace.html#the-flow-object-space 
+.. _`trace object space`: objspace.html#the-trace-object-space 
+.. _`thunk object space`: objspace.html#the-thunk-object-space 
+.. _StdObjSpace: objspace.html#the-standard-object-space 
+.. _`abstract interpretation`: theory.html#abstract-interpretation
+.. _`rpython`: coding-guide.html#rpython 
+.. _`type inferencing code`: translation.html#the-annotation-pass 
+.. _`RPython Typer`: translation.html#rpython-typer 
+.. _`testing methods`: coding-guide.html#testing-in-pypy
+.. _`translation`: translation.html 
+.. _`GenC backend`: translation.html#genc 
+.. _`LLVM backend`: translation.html#llvm 
+.. _`revision report`: http://codespeak.net/pypy/rev/current 
 
-* `Architecture introduction slides`_ a mostly up-to-date
-  introduction for the Amsterdam PyPy-Sprint Dec 2003. 
 
-* `EU funding for FOSS`_ talk on Chaos Communication
-  Conference in Berlin, Dec 2004. 
-
-* `py lib slides`_ from the py lib talk at Pycon 2005 
-  (py is used as a support/testing library for PyPy). 
-
-.. _oscon2003-paper: http://codespeak.net/pypy/index.cgi?extradoc/talk/oscon2003-paper.html
-.. _`Architecture introduction slides`: http://codespeak.net/svn/pypy/extradoc/talk/amsterdam-sprint-intro.pdf
-.. _`EU funding for FOSS`: http://codespeak.net/svn/pypy/extradoc/talk/2004-21C3-pypy-EU-hpk.pdf
-.. _`py lib slides`: http://codespeak.net/svn/pypy/extradoc/talk/2005-pycon-py.pdf
-
-Related projects 
-----------------------------------
-
-* Dynamo_ showcased `transparent dynamic optimization`_
-  generating an optimized version of a binary program at runtime. 
-
-* Tailoring Dynamo_ to interpreter implementations and challenges -
-  Gregory Sullivan et. al., 
-  `Dynamic Native Optimization of Native Interpreters`_. IVME 03. 2003.
-
-* JikesRVM_ a research dynamic optimizing Java VM written in Java.
-
-* `Squeak`_ is a Smalltalk-80 implementation written in
-  Smalltalk, being used in `Croquet`_, an experimental 
-  distributed multi-user/multi-programmer virtual world. 
-
-* `LLVM`_ the low level virtual machine project. 
-  
-* spyweb_ translates Python programs to Scheme. 
-
-* `Iron Python`_ a new Python implementation compiling Python into 
-  Microsofts Common Language Runtime (CLR) Intermediate Language (IL).
-
-* `GNU lightning`_ generates assembly language at runtime. 
-
-
-.. _`Squeak`: http://www.squeak.org/
-.. _`Croquet`: http://www.opencroquet.org/
-.. _`Iron Python`: http://www.gotdotnet.com/workspaces/workspace.aspx?id=ad7acff7-ab1e-4bcb-99c0-57ac5a3a9742
-.. _`transparent dynamic optimization`: http://www.hpl.hp.com/techreports/1999/HPL-1999-77.pdf
-.. _Dynamo: http://www.hpl.hp.com/techreports/1999/HPL-1999-78.pdf
-.. _optionaltool: http://codespeak.net/pypy/index.cgi?doc/optionaltool.html
-.. _testdesign: http://codespeak.net/pypy/index.cgi?doc/testdesign.html
-.. _feasible: http://codespeak.net/pipermail/pypy-dev/2004q2/001289.html
-.. _rock: http://codespeak.net/pipermail/pypy-dev/2004q1/001255.html
-.. _spyweb: http://spyweb.hopto.org/
-.. _`GNU lightning`: http://www.gnu.org/software/lightning/lightning.html
-.. _LLVM: http://llvm.cs.uiuc.edu/
-.. _IronPython: http://www.python.org/pycon/dc2004/papers/9/
-.. _`Dynamic Native Optimization of Native Interpreters`: http://www.ai.mit.edu/~gregs/dynamorio.html
-.. _JikesRVM: http://jikesrvm.sf.net
+.. include:: _ref.txt



More information about the Pypy-commit mailing list