[Python-checkins] cpython: Break up the 'someos' docs classification based on a more user-focused scheme,

[nick.coghlan]

http://hg.python.org/cpython/rev/717344a837ab
changeset:   78666:717344a837ab
user:        Nick Coghlan <ncoghlan at gmail.com>
date:        Mon Aug 20 18:05:46 2012 +1000
summary:
  Break up the 'someos' docs classification based on a more user-focused scheme, including creation of a separate 'Concurrent Execution' section

files:
  Doc/library/concurrency.rst |  31 +++++++++++++++++++++++++
  Doc/library/datatypes.rst   |   2 -
  Doc/library/index.rst       |   2 +-
  Doc/library/ipc.rst         |   6 ++--
  Doc/library/someos.rst      |  24 -------------------
  Doc/library/text.rst        |   2 +
  Misc/NEWS                   |   7 +++++
  7 files changed, 44 insertions(+), 30 deletions(-)


diff --git a/Doc/library/concurrency.rst b/Doc/library/concurrency.rst
new file mode 100644
--- /dev/null
+++ b/Doc/library/concurrency.rst
@@ -0,0 +1,31 @@
+.. _concurrency:
+
+********************
+Concurrent Execution
+********************
+
+The modules described in this chapter provide support for concurrent
+execution of code. The appropriate choice of tool will depend on the
+task to be executed (CPU bound vs IO bound) and preferred style of
+development (event driven cooperative multitasking vs preemptive
+multitasking) Here's an overview:
+
+
+.. toctree::
+
+   threading.rst
+   multiprocessing.rst
+   concurrent.futures.rst
+   subprocess.rst
+   sched.rst
+   queue.rst
+   select.rst
+
+
+The following are support modules for some of the above services:
+
+.. toctree::
+
+   dummy_threading.rst
+   _thread.rst
+   _dummy_thread.rst
diff --git a/Doc/library/datatypes.rst b/Doc/library/datatypes.rst
--- a/Doc/library/datatypes.rst
+++ b/Doc/library/datatypes.rst
@@ -25,8 +25,6 @@
    heapq.rst
    bisect.rst
    array.rst
-   sched.rst
-   queue.rst
    weakref.rst
    types.rst
    copy.rst
diff --git a/Doc/library/index.rst b/Doc/library/index.rst
--- a/Doc/library/index.rst
+++ b/Doc/library/index.rst
@@ -57,7 +57,7 @@
    fileformats.rst
    crypto.rst
    allos.rst
-   someos.rst
+   concurrency.rst
    ipc.rst
    netdata.rst
    markup.rst
diff --git a/Doc/library/ipc.rst b/Doc/library/ipc.rst
--- a/Doc/library/ipc.rst
+++ b/Doc/library/ipc.rst
@@ -8,7 +8,7 @@
 to communicate.
 
 Some modules only work for two processes that are on the same machine, e.g.
-:mod:`signal` and :mod:`subprocess`.  Other modules support networking protocols
+:mod:`signal` and :mod:`mmap`.  Other modules support networking protocols
 that two or more processes can used to communicate across machines.
 
 The list of modules described in this chapter is:
@@ -16,9 +16,9 @@
 
 .. toctree::
 
-   subprocess.rst
    socket.rst
    ssl.rst
-   signal.rst
    asyncore.rst
    asynchat.rst
+   signal.rst
+   mmap.rst
diff --git a/Doc/library/someos.rst b/Doc/library/someos.rst
deleted file mode 100644
--- a/Doc/library/someos.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-.. _someos:
-
-**********************************
-Optional Operating System Services
-**********************************
-
-The modules described in this chapter provide interfaces to operating system
-features that are available on selected operating systems only. The interfaces
-are generally modeled after the Unix or C interfaces but they are available on
-some other systems as well (e.g. Windows).  Here's an overview:
-
-
-.. toctree::
-
-   select.rst
-   threading.rst
-   multiprocessing.rst
-   concurrent.futures.rst
-   mmap.rst
-   readline.rst
-   rlcompleter.rst
-   dummy_threading.rst
-   _thread.rst
-   _dummy_thread.rst
diff --git a/Doc/library/text.rst b/Doc/library/text.rst
--- a/Doc/library/text.rst
+++ b/Doc/library/text.rst
@@ -21,4 +21,6 @@
    textwrap.rst
    unicodedata.rst
    stringprep.rst
+   readline.rst
+   rlcompleter.rst
 
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -55,6 +55,13 @@
 Documentation
 -------------
 
+- Create a 'Concurrent Execution' section in the docs, and split up the
+  'Optional Operating System Services' section to use a more user-centric
+  classification scheme (splitting them across the new CE section, IPC and
+  text processing). Operating system limitatons can be reflected with
+  the Sphinx :platform: tag, it doesn't make sense as part of the Table of
+  Contents.
+
 - Issue #4966: Bring the sequence docs up to date for the Py3k transition
   and the many language enhancements since they were original written
 

-- 
Repository URL: http://hg.python.org/cpython