aboutsummaryrefslogtreecommitdiff
path: root/docs/library/uos.rst
AgeCommit message (Collapse)Author
2020-08-25extmod/vfs_lfs: Add mtime support to littlefs files.Damien George
This commit adds support for modification time of files on littlefs v2 filesystems, using file attributes. For some background see issue #6114. Features/properties of this implementation: - Only supported on littlefs2 (not littlefs1). - Uses littlefs2's general file attributes to store the timestamp. - The timestamp is 64-bits and stores nanoseconds since 1970/1/1 (if the range to the year 2554 is not enough then additional bits can be added to this timestamp by adding another file attribute). - mtime is enabled by default but can be disabled in the constructor, eg: uos.mount(uos.VfsLfs2(bdev, mtime=False), '/flash') - It's fully backwards compatible, existing littlefs2 filesystems will work without reformatting and timestamps will be added transparently to existing files (once they are opened for writing). - Files without timestamps will open correctly, and stat will just return 0 for their timestamp. - mtime can be disabled or enabled each mount time and timestamps will only be updated if mtime is enabled (otherwise they will be untouched). Signed-off-by: Damien George <damien@micropython.org>
2020-08-21docs: Change `\*` to `*` in argument lists.Zenix27
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and will render the `\` in the output if it is there, so remove it. Fixes issue #6209.
2020-06-05docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build.David Lechner
This enables warnings as errors and fixes all current errors, namely: - reference to terms in the glossary must now be explicit (:term:) - method overloads must not be declared as a separate method or must use :noindex: - 2 cases where `` should have been used instead of `
2020-01-22docs/library/uos.rst: Improve block devices section, and ioctl ret vals.Peter Hinch
2020-01-12docs/library: Add / to indicate positional-only args in library docs.Jason Neal
Removes the confusion of positional-only arguments which have defaults that look like keyword arguments.
2019-12-16docs/library/uos.rst: Clarify why the extended interface exists.Jim Mussared
2019-12-10docs/library/uos: Add notes and links about littlefs failures.Damien George
2019-12-04docs: Add littlefs docs and a filesystem tutorial.Jim Mussared
2019-10-29docs/library: Add documentation for extended block device protocol.Damien George
2019-10-16docs: Fix spelling in various parts of the docs.Mike Causer
2019-02-26docs/uos: Document extra requirements on stream objs passed to dupterm.Yonatan Goldschmidt
This is only correct for the extmod/uos_dupterm.c implementation however, as e.g cc3200 implementation does the mp_load_method() itself, and anyway requires `read` instead of `readinto`.
2018-06-28docs/uos: Make it clear that block device block_num param is an index.Damien George
2018-03-12extmod/vfs_fat: Add file size as 4th element of uos.ilistdir tuple.Tom Collins
2018-03-07docs/library/uos: Document mount, umount, VfsFat and block devices.Damien George
2018-03-07docs/library/uos: Create sections for distinct parts and document uname.Damien George
2017-12-04docs/library: Add xrefs to "stream" dictionary entry for many modules.Paul Sokolovsky
2017-08-29docs/library: Add description of "index" parameter to uos.dupterm().Damien George
2017-07-02docs/library: Add CPython docs xref to each pertinent module.Paul Sokolovsky
Cross-reference text/link is implemented as RST substitution, so easy to consistently.
2017-06-28docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-03docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc.Paul Sokolovsky
This patch also unconditionalizes uos.dupterm(), though exact interface and semantics is yet to be defined.
2017-06-03docs/uos: Deconditionalize, remove minor port-specific details.Paul Sokolovsky
For a couple of ports, there was information which directory is set as current after boot. This information doesn't belong to "uos" module, and is moved to boards' references (which actually already contained information on which directory is chosen for boot, even if without explicit mentioning that it becomes current directory, which is now done).
2017-05-10docs/library/uos: Add description of uos.ilistdir() function.Damien George
2017-04-16docs/library/uos: urandom: Generalize description.Paul Sokolovsky
Don't give a guarantee of HW RNG, only a possibility of its usage.
2017-04-05docs/uos: De-conditionalize statvfs() description.Paul Sokolovsky
It's a standard function, and it's already described (in the library intro) that for any given port, any function may be missing.
2017-02-14docs/uos: Remove mention of uos.sep.Paul Sokolovsky
MicroPython guarantees '/' to be a path separator, so extra constant taking precious ROM space are not needed. MicroPython never had such constant, only one vendor port had it (now unmaintained).
2016-10-07docs/uos: Add uos.statvfs() documentation.Alex March
2016-08-02docs: Spelling mistakesMike Causer
2016-04-27docs: Fix uos and utime heading underlines to be the correct length.Damien George
Otherwise Sphinx gives a warning.
2016-04-27docs/library: "os" module is actually "uos".Paul Sokolovsky