micropython/docs/library
Damien George 2acc087880 extmod/vfs_lfs: Add mtime support to littlefs files.
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-25 17:35:19 +10:00
..
_thread.rst docs/_thread: Add a placeholder docs for _thread module. 2017-11-10 00:09:43 +02:00
btree.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
builtins.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
cmath.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
esp.rst docs/library: Clarify that the arg to esp.deepsleep is in microseconds. 2020-06-30 22:01:44 +10:00
esp32.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
framebuf.rst docs/library: Fix framebuf monochrome 1-bit modes, swapping HLSB/HMSB. 2020-02-10 23:04:15 +11:00
gc.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
index.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
lcd160cr.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.ADC.rst docs/library: Specify new machine.ADC class. 2019-09-04 15:35:09 +10:00
machine.ADCWiPy.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.I2C.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.Pin.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.RTC.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.SD.rst docs/machine: Add initial docs for new machine.SDCard class. 2019-06-03 00:42:24 +10:00
machine.SDCard.rst esp32/machine_sdcard: Add "freq" keyword arg to SDCard constructor. 2020-05-28 12:19:04 +10:00
machine.SPI.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.Signal.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.Timer.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.TimerWiPy.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.UART.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.WDT.rst docs/library: Fix docs for machine.WDT to specify millisecond timeout. 2020-05-02 22:55:48 +10:00
machine.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
math.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
micropython.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
network.CC3K.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
network.WIZNET5K.rst docs/library/network: Move specific network classes to their own file. 2018-09-27 17:23:42 +10:00
network.WLAN.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
network.WLANWiPy.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
network.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.ADC.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Accel.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.CAN.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.DAC.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.ExtInt.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Flash.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.I2C.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.LCD.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.LED.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Pin.rst docs/pyb.Pin: Minor typo fix to specify Pin in pyb.Pin.cpu. 2018-10-19 17:31:59 +11:00
pyb.RTC.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.SPI.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.Servo.rst docs/pyb.*: Use proper class case in method headers. 2016-06-08 16:21:28 +03:00
pyb.Switch.rst docs: Fix some references and RST markup to eliminate Sphinx warnings. 2018-03-15 15:50:51 +11:00
pyb.Timer.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.UART.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.USB_HID.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.USB_VCP.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
sys.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
uarray.rst docs/library: Rename "array" module to "uarray". 2019-10-22 16:40:58 +11:00
uasyncio.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
ubinascii.rst docs/library/ubinascii: Update base64 docs. 2017-08-17 09:25:51 +03:00
ubluetooth.rst docs/library: For ubluetooth, add docs for _IRQ_GATTS_INDICATE_DONE. 2020-07-20 23:28:31 +10:00
ucollections.rst docs/library: Add documentation for ucollections.deque. 2018-06-26 14:29:22 +10:00
ucryptolib.rst extmod/moducryptolib: Add AES-CTR support. 2019-05-06 18:09:48 +10:00
uctypes.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
uerrno.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
uhashlib.rst docs: Fix spelling in various parts of the docs. 2019-10-16 14:08:28 +11:00
uheapq.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
uio.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
ujson.rst docs/library/ujson: Document dump() and load() functions. 2018-02-15 11:37:48 +11:00
uos.rst extmod/vfs_lfs: Add mtime support to littlefs files. 2020-08-25 17:35:19 +10:00
ure.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
uselect.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
usocket.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
ussl.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
ustruct.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
utime.rst docs/library/utime: Fix incorrect example with ticks_diff args order. 2017-11-30 14:56:08 +11:00
uzlib.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
wipy.rst docs: Add usocket and ussl modules' documentation. 2015-10-21 15:30:56 +02:00