summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2018-07-29 16:47:06 -0400
committerDan Halbert <halbert@halwitz.org>2018-07-29 16:47:06 -0400
commitc76a4d477fdfd939f144c036479a6d0bde3543c0 (patch)
tree5fe406cc9ecf94e34d1c088df62f6cee7f48854b /docs
parentbfbb5cde5a7e629d80a58fc75f8c15b7c45e5503 (diff)
remove qemu-arm build; fix docs build bugs
Diffstat (limited to 'docs')
-rw-r--r--docs/library/_thread.rst12
-rw-r--r--docs/library/btree.rst2
-rw-r--r--docs/library/micropython.rst46
-rw-r--r--docs/library/sys.rst6
-rw-r--r--docs/library/uselect.rst4
-rw-r--r--docs/library/usocket.rst4
-rw-r--r--docs/library/ussl.rst4
-rw-r--r--docs/library/uzlib.rst2
8 files changed, 11 insertions, 69 deletions
diff --git a/docs/library/_thread.rst b/docs/library/_thread.rst
deleted file mode 100644
index 47c1c2392..000000000
--- a/docs/library/_thread.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-:mod:`_thread` -- multithreading support
-========================================
-
-.. module:: _thread
- :synopsis: multithreading support
-
-|see_cpython_module| :mod:`python:_thread`.
-
-This module implements multithreading support.
-
-This module is highly experimental and its API is not yet fully settled
-and not yet described in this documentation.
diff --git a/docs/library/btree.rst b/docs/library/btree.rst
index 3059da7a4..4c7b30d5c 100644
--- a/docs/library/btree.rst
+++ b/docs/library/btree.rst
@@ -7,7 +7,7 @@
:synopsis: simple BTree database
The ``btree`` module implements a simple key-value database using external
-storage (disk files, or in general case, a random-access `stream`). Keys are
+storage (disk files, or in general case, a random-access ``stream``). Keys are
stored sorted in the database, and besides efficient retrieval by a key
value, a database also supports efficient ordered range scans (retrieval
of values with the keys in a given range). On the application interface
diff --git a/docs/library/micropython.rst b/docs/library/micropython.rst
index 0ba3fbbc5..31065fbe5 100644
--- a/docs/library/micropython.rst
+++ b/docs/library/micropython.rst
@@ -47,17 +47,6 @@ Functions
The default optimisation level is usually level 0.
-.. function:: alloc_emergency_exception_buf(size)
-
- Allocate *size* bytes of RAM for the emergency exception buffer (a good
- size is around 100 bytes). The buffer is used to create exceptions in cases
- when normal RAM allocation would fail (eg within an interrupt handler) and
- therefore give useful traceback information in these situations.
-
- A good way to use this function is to put it at the start of your main script
- (eg ``boot.py`` or ``main.py``) and then the emergency exception buffer will be active
- for all the code following it.
-
.. function:: mem_info([verbose])
Print information about currently used memory. If the *verbose* argument
@@ -102,38 +91,3 @@ Functions
This function can be used to prevent the capturing of Ctrl-C on the
incoming stream of characters that is usually used for the REPL, in case
that stream is used for other purposes.
-
-.. function:: schedule(func, arg)
-
- Schedule the function *func* to be executed "very soon". The function
- is passed the value *arg* as its single argument. "Very soon" means that
- the MicroPython runtime will do its best to execute the function at the
- earliest possible time, given that it is also trying to be efficient, and
- that the following conditions hold:
-
- - A scheduled function will never preempt another scheduled function.
- - Scheduled functions are always executed "between opcodes" which means
- that all fundamental Python operations (such as appending to a list)
- are guaranteed to be atomic.
- - A given port may define "critical regions" within which scheduled
- functions will never be executed. Functions may be scheduled within
- a critical region but they will not be executed until that region
- is exited. An example of a critical region is a preempting interrupt
- handler (an IRQ).
-
- A use for this function is to schedule a callback from a preempting IRQ.
- Such an IRQ puts restrictions on the code that runs in the IRQ (for example
- the heap may be locked) and scheduling a function to call later will lift
- those restrictions.
-
- Note: If `schedule()` is called from a preempting IRQ, when memory
- allocation is not allowed and the callback to be passed to `schedule()` is
- a bound method, passing this directly will fail. This is because creating a
- reference to a bound method causes memory allocation. A solution is to
- create a reference to the method in the class constructor and to pass that
- reference to `schedule()`. This is discussed in detail here
- :ref:`reference documentation <isr_rules>` under "Creation of Python
- objects".
-
- There is a finite stack to hold the scheduled functions and `schedule()`
- will raise a `RuntimeError` if the stack is full.
diff --git a/docs/library/sys.rst b/docs/library/sys.rst
index c43218509..2aa15531a 100644
--- a/docs/library/sys.rst
+++ b/docs/library/sys.rst
@@ -105,15 +105,15 @@ Constants
.. data:: stderr
- Standard error `stream`.
+ Standard error ``stream``.
.. data:: stdin
- Standard input `stream`.
+ Standard input ``stream``.
.. data:: stdout
- Standard output `stream`.
+ Standard output ``stream``.
.. data:: version
diff --git a/docs/library/uselect.rst b/docs/library/uselect.rst
index fb365facd..a2b408b20 100644
--- a/docs/library/uselect.rst
+++ b/docs/library/uselect.rst
@@ -9,7 +9,7 @@
|see_cpython_module| :mod:`cpython:select`.
This module provides functions to efficiently wait for events on multiple
-`streams <stream>` (select streams which are ready for operations).
+``stream`` objects (select streams which are ready for operations).
Functions
---------
@@ -35,7 +35,7 @@ Methods
.. method:: poll.register(obj[, eventmask])
- Register `stream` *obj* for polling. *eventmask* is logical OR of:
+ Register ``stream`` *obj* for polling. *eventmask* is logical OR of:
* ``uselect.POLLIN`` - data available for reading
* ``uselect.POLLOUT`` - more data can be written
diff --git a/docs/library/usocket.rst b/docs/library/usocket.rst
index 582742f2e..2751db6c4 100644
--- a/docs/library/usocket.rst
+++ b/docs/library/usocket.rst
@@ -14,7 +14,7 @@ This module provides access to the BSD socket interface.
.. admonition:: Difference to CPython
:class: attention
- For efficiency and consistency, socket objects in MicroPython implement a `stream`
+ For efficiency and consistency, socket objects in MicroPython implement a ``stream``
(file-like) interface directly. In CPython, you need to convert a socket to
a file-like object using `makefile()` method. This method is still supported
by MicroPython (but is a no-op), so where compatibility with CPython matters,
@@ -245,7 +245,7 @@ Methods
Not every ``MicroPython port`` supports this method. A more portable and
generic solution is to use `uselect.poll` object. This allows to wait on
multiple objects at the same time (and not just on sockets, but on generic
- `stream` objects which support polling). Example::
+ ``stream`` objects which support polling). Example::
# Instead of:
s.settimeout(1.0) # time in seconds
diff --git a/docs/library/ussl.rst b/docs/library/ussl.rst
index 5df2e5b53..91a64b025 100644
--- a/docs/library/ussl.rst
+++ b/docs/library/ussl.rst
@@ -17,9 +17,9 @@ Functions
.. function:: ussl.wrap_socket(sock, server_side=False, keyfile=None, certfile=None, cert_reqs=CERT_NONE, ca_certs=None)
- Takes a `stream` *sock* (usually usocket.socket instance of ``SOCK_STREAM`` type),
+ Takes a ``stream`` *sock* (usually usocket.socket instance of ``SOCK_STREAM`` type),
and returns an instance of ssl.SSLSocket, which wraps the underlying stream in
- an SSL context. Returned object has the usual `stream` interface methods like
+ an SSL context. Returned object has the usual ``stream`` interface methods like
``read()``, ``write()``, etc. In MicroPython, the returned object does not expose
socket interface and methods like ``recv()``, ``send()``. In particular, a
server-side SSL socket should be created from a normal socket returned from
diff --git a/docs/library/uzlib.rst b/docs/library/uzlib.rst
index f736ace81..ba08b535c 100644
--- a/docs/library/uzlib.rst
+++ b/docs/library/uzlib.rst
@@ -27,7 +27,7 @@ Functions
.. class:: DecompIO(stream, wbits=0)
- Create a `stream` wrapper which allows transparent decompression of
+ Create a ``stream`` wrapper which allows transparent decompression of
compressed data in another *stream*. This allows to process compressed
streams with data larger than available heap size. In addition to
values described in :func:`decompress`, *wbits* may take values