diff options
author | Daniel Campora <daniel@wipy.io> | 2015-06-10 23:29:56 +0200 |
---|---|---|
committer | Daniel Campora <daniel@wipy.io> | 2015-06-10 23:37:56 +0200 |
commit | cfcf47c0644952358e1a260db159e807872a37e6 (patch) | |
tree | 02522a025a7b803d7de0589dd743b34f3daa4634 /docs/library/os.rst | |
parent | b630de1103cd07ac0656c76c7f90d92312705835 (diff) | |
download | micropython-cfcf47c0644952358e1a260db159e807872a37e6.tar.gz micropython-cfcf47c0644952358e1a260db159e807872a37e6.zip |
docs: Add initial draft documentation for the WiPy.
This makes all common files "port-aware" using the .. only directive.
Diffstat (limited to 'docs/library/os.rst')
-rw-r--r-- | docs/library/os.rst | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/docs/library/os.rst b/docs/library/os.rst index e9b7d40bf5..e32a409f53 100644 --- a/docs/library/os.rst +++ b/docs/library/os.rst @@ -16,8 +16,14 @@ available physical drives are accessible from here. They are currently: ``/sd`` -- the SD card (if it exists) -On boot up, the current directory is ``/flash`` if no SD card is inserted, -otherwise it is ``/sd``. +.. 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 --------- @@ -63,6 +69,12 @@ Functions Return a bytes object with n random bytes, generated by the hardware random number generator. +.. only:: port_wipy + + .. function:: mkfs(drive) + + Formats the specified drive, must be either ``/flash`` or ``/sd``. + Constants --------- |