Skip to content

Commit 924a3e0

Browse files
jimmojimmo
committed
top: Replace upip with mip everywhere.
Updates all README.md and docs, and manifests to `require("mip")`. Also extend and improve the documentation on freezing and packaging. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
1 parent ba3652f commit 924a3e0

16 files changed

Lines changed: 404 additions & 878 deletions

File tree

‎docs/develop/gettingstarted.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,8 @@ tests
322322

323323
tools
324324

325-
Contains helper tools including the ``upip`` and the ``pyboard.py`` module.
325+
Contains scripts used by the build and CI process, as well as user tools such
326+
as ``pyboard.py`` and ``mpremote``.
326327

327328
examples
328329

‎docs/develop/optimizations.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ into the firmware image as part of the main firmware compilation process, which
2525
the bytecode will be executed from ROM. This can lead to a significant memory saving, and
2626
reduce heap fragmentation.
2727

28+
See :ref:`manifest` for more information.
29+
2830
Variables
2931
---------
3032

‎docs/esp8266/tutorial/intro.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ convertor to make the UART available to your PC.
2323
The minimum requirement for flash size is 1Mbyte. There is also a special
2424
build for boards with 512KB, but it is highly limited comparing to the
2525
normal build: there is no support for filesystem, and thus features which
26-
depend on it won't work (WebREPL, upip, etc.). As such, 512KB build will
26+
depend on it won't work (WebREPL, mip, etc.). As such, 512KB build will
2727
be more interesting for users who build from source and fine-tune parameters
2828
for their particular application.
2929

‎docs/pyboard/tutorial/lcd160cr_skin.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ There is a test program which you can use to test the features of the display,
4242
and which also serves as a basis to start creating your own code that uses the
4343
LCD. This test program is available on GitHub
4444
`here <https://github.com/micropython/micropython/blob/master/drivers/display/lcd160cr_test.py>`__.
45-
Copy it to the board over USB mass storage, or by using `mpremote`.
45+
Copy it to the board over USB mass storage, or by using :ref:`mpremote`.
4646

4747
To run the test from the MicroPython prompt do::
4848

‎docs/reference/glossary.rst‎

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Glossary
5252
cross-compiler
5353
Also known as ``mpy-cross``. This tool runs on your PC and converts a
5454
:term:`.py file` containing MicroPython code into a :term:`.mpy file`
55-
containing MicroPython bytecode. This means it loads faster (the board
55+
containing MicroPython :term:`bytecode`. This means it loads faster (the board
5656
doesn't have to compile the code), and uses less space on flash (the
5757
bytecode is more space efficient).
5858

@@ -128,7 +128,7 @@ Glossary
128128

129129
Unlike the :term:`CPython` stdlib, micropython-lib modules are
130130
intended to be installed individually - either using manual copying or
131-
using :term:`upip`.
131+
using :term:`mip`.
132132

133133
MicroPython port
134134
MicroPython supports different :term:`boards <board>`, RTOSes, and
@@ -151,16 +151,26 @@ Glossary
151151
machine-independent features. It can also function in a similar way to
152152
:term:`CPython`'s ``python`` executable.
153153

154+
mip
155+
A package installer for MicroPython (mip - "mip installs packages"). It
156+
installs MicroPython packages either from :term:`micropython-lib`,
157+
GitHub, or arbitrary URLs. mip can be used on-device on
158+
network-capable boards, and internally by tools such
159+
as :term:`mpremote`.
160+
161+
mpremote
162+
A tool for interacting with a MicroPython device. See :ref:`mpremote`.
163+
154164
.mpy file
155165
The output of the :term:`cross-compiler`. A compiled form of a
156-
:term:`.py file` that contains MicroPython bytecode instead of Python
157-
source code.
166+
:term:`.py file` that contains MicroPython :term:`bytecode` instead of
167+
Python source code.
158168

159169
native
160170
Usually refers to "native code", i.e. machine code for the target
161171
microcontroller (such as ARM Thumb, Xtensa, x86/x64). The ``@native``
162172
decorator can be applied to a MicroPython function to generate native
163-
code instead of bytecode for that function, which will likely be
173+
code instead of :term:`bytecode` for that function, which will likely be
164174
faster but use more RAM.
165175

166176
port
@@ -193,8 +203,10 @@ Glossary
193203
as a serial port over USB.
194204

195205
upip
196-
(Literally, "micro pip"). A package manager for MicroPython, inspired
206+
A now-obsolete package manager for MicroPython, inspired
197207
by :term:`CPython`'s pip, but much smaller and with reduced
198-
functionality.
199-
upip runs both on the :term:`Unix port <MicroPython Unix port>` and on
200-
:term:`baremetal` ports which offer filesystem and networking support.
208+
functionality. See its replacement, :term:`mip`.
209+
210+
webrepl
211+
A way of connecting to the REPL (and transferring files) on a device
212+
over the internet from a browser. See https://micropython.org/webrepl

0 commit comments

Comments
 (0)