Skip to content

Commit 3ac4a0d

Browse files
author
Anselm Kruis
committed
Fix issue python#35: Update readme.txt
I added some useful content: - where to look for information - minimal build instructions - contributing to Stackless The previous content was of historic interest only. (grafted from e5d03215d11e9e424da088811481ce8cda557af4)
1 parent cbbad95 commit 3ac4a0d

File tree

1 file changed

+55
-7
lines changed

1 file changed

+55
-7
lines changed

Stackless/readme.txt

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,51 @@
1+
About Stackless Python
2+
======================
3+
4+
You can find information about Stackless Python in the following
5+
places:
6+
7+
1. The Manual
8+
9+
Stackless extends the Python documentation. The entry point
10+
is the file Doc/stackless-python.rst. Or read the documentation online
11+
at http://stackless.readthedocs.io/en/latest/stackless-python.html
12+
13+
2. The Stackless Web Site http://www.stackless.com
14+
15+
The FAQ (https://bitbucket.org/stackless-dev/stackless/wiki/FAQ) has
16+
a list of further readings.
17+
18+
3. The Mailing List
19+
20+
If you still have questions, don't hesitate to post to the
21+
Stackless mailing list: http://www.stackless.com/mailman/listinfo/stackless
22+
23+
4. The Source
24+
25+
It is the ultimate truth. Read it at https://bitbucket.org/stackless-dev/stackless
26+
27+
Building Stackless
28+
------------------
29+
30+
Just follow the build instructions for regular Python. If you define
31+
the C-preprocessor symbol STACKLESS_OFF, you get a Python interpreter
32+
without Stackless. It should behave exactly like the corresponding
33+
version of regular Python. Any difference constitutes a bug.
34+
35+
36+
Contributing
37+
------------
38+
39+
Contributions are always welcome. Please open an issue or create
40+
a pull request at https://bitbucket.org/stackless-dev/stackless.
41+
42+
43+
##################################################################
44+
# #
45+
# WARNING: the following text is of historical interest only #
46+
# #
47+
##################################################################
48+
149
A small update as of 2006-03-01
250

351
Meanwhile a long time has passed since the initial Stackless
@@ -54,9 +102,9 @@ support for real OS threads as a tasklet. Phew.
54102
(this part is slightly obscure due to my nature,
55103
but he is still eager to learn)
56104

57-
- the users requests should be followed first.
58-
Especially, coroutines and microthreads are of larger interest.
59-
Generators are less interesting, since Python 2.2 includes a
105+
- the users requests should be followed first.
106+
Especially, coroutines and microthreads are of larger interest.
107+
Generators are less interesting, since Python 2.2 includes a
60108
marveless, stack based implementation which is hard to improve.
61109
The abilities of continuations have been experienced by only
62110
a very small group of insiders, and they agreed that these
@@ -82,7 +130,7 @@ support for real OS threads as a tasklet. Phew.
82130
off in the way I intended. Especially, Stackless Python was never
83131
understood good enough to be incorporated into the Standard Python
84132
distribution. Instead of a warm welcome and instructions how to
85-
make the sources suitable for inclusion, I got rejections and dissings,
133+
make the sources suitable for inclusion, I got rejections and dissings,
86134
especially from Guido. At that time I was really disappointed, and
87135
it took some time to understand that his reaction was absolutely
88136
correct. The code was simply too tricky and complicated, and the
@@ -96,7 +144,7 @@ support for real OS threads as a tasklet. Phew.
96144
which have an absolute need for its feature meanwhile, and my work
97145
also continuously gets some sponsorship from game developers.
98146
In April, I was also hired by IronPort to work on Stackless, which is great.
99-
147+
100148
*****************************************************************************
101149

102150
The New Concept!
@@ -121,7 +169,7 @@ support for real OS threads as a tasklet. Phew.
121169
I cannot support all of it. Of course there are helpers. but what is
122170
the general strategy?
123171

124-
172+
125173
The answer is:
126174
==============
127175

@@ -157,7 +205,7 @@ support for real OS threads as a tasklet. Phew.
157205
data that makes up a frame's C impact, put it into a structure
158206
and stick it into a memory area in the frame. After this, the C
159207
stack is cleared from the frame specific stuff.
160-
The frame contains a procedure which is able to restore this frame
208+
The frame contains a procedure which is able to restore this frame
161209
state on demand.
162210

163211
The interested reader will have noticed, that this concept covers

0 commit comments

Comments
 (0)