From 66cd10d43977ee09cc92a06b01af1a58afd36894 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Wed, 21 Aug 2019 16:20:40 +0200
Subject: [PATCH] docs: Document os.reset()
Signed-off-by: Rahix <rahix@rahix.de>
---
Documentation/pycardium/os.rst | 9 +++++++++
pycardium/modules/os.c | 18 +++++++++---------
2 files changed, 18 insertions(+), 9 deletions(-)
diff --git a/Documentation/pycardium/os.rst b/Documentation/pycardium/os.rst
index 5b450fd3..c2c51ee3 100644
--- a/Documentation/pycardium/os.rst
+++ b/Documentation/pycardium/os.rst
@@ -43,3 +43,12 @@ Epicardium-Specific
:param str name: Path to new app/script/l0dable.
:return: This function never returns. It can, however raise an exception.
+
+.. py:function:: os.reset()
+
+ Reboot card10.
+
+ .. warning::
+
+ Please only call this function if absolutely necessary. In most cases
+ you'll want to just :py:func:`os.exit` instead.
diff --git a/pycardium/modules/os.c b/pycardium/modules/os.c
index d2a4ec55..385cc9de 100644
--- a/pycardium/modules/os.c
+++ b/pycardium/modules/os.c
@@ -19,15 +19,6 @@ static mp_obj_t mp_os_exit(size_t n_args, const mp_obj_t *args)
}
static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(exit_obj, 0, 1, mp_os_exit);
-static mp_obj_t mp_os_reset(void)
-{
- epic_system_reset();
-
- /* unreachable */
- return mp_const_none;
-}
-static MP_DEFINE_CONST_FUN_OBJ_0(reset_obj, mp_os_reset);
-
static mp_obj_t mp_os_exec(mp_obj_t name_in)
{
const char *name_ptr;
@@ -57,6 +48,15 @@ static mp_obj_t mp_os_exec(mp_obj_t name_in)
}
static MP_DEFINE_CONST_FUN_OBJ_1(exec_obj, mp_os_exec);
+static mp_obj_t mp_os_reset(void)
+{
+ epic_system_reset();
+
+ /* unreachable */
+ return mp_const_none;
+}
+static MP_DEFINE_CONST_FUN_OBJ_0(reset_obj, mp_os_reset);
+
static mp_obj_t mp_os_listdir(mp_obj_t py_path)
{
const char *path = mp_obj_str_get_str(py_path);
--
GitLab