From 351ec6d4ab587bb5434437271ff40a00a34e6fa7 Mon Sep 17 00:00:00 2001 From: Paul Sokolovsky Date: Wed, 27 Apr 2016 01:55:06 +0300 Subject: docs/library: "os" module is actually "uos". --- docs/library/index.rst | 8 ++-- docs/library/os.rst | 102 ------------------------------------------------- docs/library/uos.rst | 102 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 106 insertions(+), 106 deletions(-) delete mode 100644 docs/library/os.rst create mode 100644 docs/library/uos.rst (limited to 'docs/library') diff --git a/docs/library/index.rst b/docs/library/index.rst index a6d12f678..87fbb3cff 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -30,13 +30,13 @@ library. cmath.rst gc.rst math.rst - os.rst select.rst sys.rst ubinascii.rst uhashlib.rst uheapq.rst ujson.rst + uos.rst ure.rst usocket.rst ustruct.rst @@ -51,13 +51,13 @@ library. cmath.rst gc.rst math.rst - os.rst select.rst sys.rst ubinascii.rst uhashlib.rst uheapq.rst ujson.rst + uos.rst ure.rst usocket.rst ustruct.rst @@ -70,11 +70,11 @@ library. :maxdepth: 1 gc.rst - os.rst select.rst sys.rst ubinascii.rst ujson.rst + uos.rst ure.rst usocket.rst ussl.rst @@ -87,12 +87,12 @@ library. gc.rst math.rst - os.rst sys.rst ubinascii.rst uhashlib.rst uheapq.rst ujson.rst + uos.rst ure.rst usocket.rst ustruct.rst diff --git a/docs/library/os.rst b/docs/library/os.rst deleted file mode 100644 index e6777147a..000000000 --- a/docs/library/os.rst +++ /dev/null @@ -1,102 +0,0 @@ -:mod:`os` -- basic "operating system" services -============================================== - -.. module:: os - :synopsis: basic "operating system" services - -The ``os`` module contains functions for filesystem access and ``urandom`` -function. - -Port specifics --------------- - -The filesystem has ``/`` as the root directory and the -available physical drives are accessible from here. They are currently: - - ``/flash`` -- the internal flash filesystem - - ``/sd`` -- the SD card (if it exists) - -.. only:: port_pyboard - - On boot up, the current directory is ``/flash`` if no SD card is inserted, - otherwise it is ``/sd``. - -.. only:: port_wipy - - On boot up, the current directory is ``/flash``. - -Functions ---------- - -.. function:: chdir(path) - - Change current directory. - -.. function:: getcwd() - - Get the current directory. - -.. function:: listdir([dir]) - - With no argument, list the current directory. Otherwise list the given directory. - -.. function:: mkdir(path) - - Create a new directory. - -.. function:: remove(path) - - Remove a file. - -.. function:: rmdir(path) - - Remove a directory. - -.. function:: rename(old_path, new_path) - - Rename a file. - -.. function:: stat(path) - - Get the status of a file or directory. - -.. function:: sync() - - Sync all filesystems. - -.. function:: urandom(n) - - Return a bytes object with n random bytes, generated by the hardware - random number generator. - -.. only:: port_wipy - - .. function:: mount(block_device, mount_point, \*, readonly=False) - - Mounts a block device (like an ``SD`` object) in the specified mount - point. Example:: - - os.mount(sd, '/sd') - - .. function:: unmount(path) - - Unmounts a prevoulsy mounted block device from the given path. - - .. function:: mkfs(block_device or path) - - Formats the specified path, must be either ``/flash`` or ``/sd``. - A block device can also be passed like an ``SD`` object before - being mounted. - - .. function:: dupterm(stream_object) - - Duplicate the terminal (the REPL) on the passed stream-like object. - The given object must at least implement the ``.read()`` and ``.write()`` methods. - -Constants ---------- - -.. data:: sep - - separation character used in paths diff --git a/docs/library/uos.rst b/docs/library/uos.rst new file mode 100644 index 000000000..f043883ad --- /dev/null +++ b/docs/library/uos.rst @@ -0,0 +1,102 @@ +:mod:`uos` -- basic "operating system" services +============================================== + +.. module:: uos + :synopsis: basic "operating system" services + +The ``os`` module contains functions for filesystem access and ``urandom`` +function. + +Port specifics +-------------- + +The filesystem has ``/`` as the root directory and the +available physical drives are accessible from here. They are currently: + + ``/flash`` -- the internal flash filesystem + + ``/sd`` -- the SD card (if it exists) + +.. only:: port_pyboard + + On boot up, the current directory is ``/flash`` if no SD card is inserted, + otherwise it is ``/sd``. + +.. only:: port_wipy + + On boot up, the current directory is ``/flash``. + +Functions +--------- + +.. function:: chdir(path) + + Change current directory. + +.. function:: getcwd() + + Get the current directory. + +.. function:: listdir([dir]) + + With no argument, list the current directory. Otherwise list the given directory. + +.. function:: mkdir(path) + + Create a new directory. + +.. function:: remove(path) + + Remove a file. + +.. function:: rmdir(path) + + Remove a directory. + +.. function:: rename(old_path, new_path) + + Rename a file. + +.. function:: stat(path) + + Get the status of a file or directory. + +.. function:: sync() + + Sync all filesystems. + +.. function:: urandom(n) + + Return a bytes object with n random bytes, generated by the hardware + random number generator. + +.. only:: port_wipy + + .. function:: mount(block_device, mount_point, \*, readonly=False) + + Mounts a block device (like an ``SD`` object) in the specified mount + point. Example:: + + os.mount(sd, '/sd') + + .. function:: unmount(path) + + Unmounts a prevoulsy mounted block device from the given path. + + .. function:: mkfs(block_device or path) + + Formats the specified path, must be either ``/flash`` or ``/sd``. + A block device can also be passed like an ``SD`` object before + being mounted. + + .. function:: dupterm(stream_object) + + Duplicate the terminal (the REPL) on the passed stream-like object. + The given object must at least implement the ``.read()`` and ``.write()`` methods. + +Constants +--------- + +.. data:: sep + + separation character used in paths -- cgit v1.2.3