Skip to content

Commit 45e4115

Browse files
dpgeorgedpgeorge
committed
Merge remote-tracking branch 'upstream/master' into esp32
2 parents 3c4e026 + 1ed3356 commit 45e4115

File tree

448 files changed

+7176
-2442
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

448 files changed

+7176
-2442
lines changed

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
*.dis
1010
*.exe
1111

12-
# Packages
12+
# Packages
1313
############
1414

1515
# Logs and Databases

‎.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ script:
4040
- make -C qemu-arm test
4141
- make -C stmhal
4242
- make -C stmhal BOARD=PYBV11 MICROPY_PY_WIZNET5K=1 MICROPY_PY_CC3K=1
43-
- make -C stmhal BOARD=STM32F7DISC
43+
- make -C stmhal BOARD=STM32F769DISC
4444
- make -C stmhal BOARD=STM32L476DISC
4545
- make -C teensy
4646
- make -C cc3200 BTARGET=application BTYPE=release

‎CODECONVENTIONS.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ White space:
7373
keyword and the opening parenthesis.
7474
- Put 1 space after a comma, and 1 space around operators.
7575

76-
Braces:
76+
Braces:
7777
- Use braces for all blocks, even no-line and single-line pieces of
7878
code.
7979
- Put opening braces on the end of the line it belongs to, not on
@@ -135,3 +135,76 @@ Type declarations:
135135
int member;
136136
void *data;
137137
} my_struct_t;
138+
139+
Documentation conventions
140+
=========================
141+
142+
MicroPython generally follows CPython in documentation process and
143+
conventions. reStructuredText syntax is used for the documention.
144+
145+
Specific conventions/suggestions:
146+
147+
* Use `*` markup to refer to arguments of a function, e.g.:
148+
149+
```
150+
.. method:: poll.unregister(obj)
151+
152+
Unregister *obj* from polling.
153+
```
154+
155+
* Use following syntax for cross-references/cross-links:
156+
157+
```
158+
:func:`foo` - function foo in current module
159+
:func:`module1.foo` - function foo in module "module1"
160+
(similarly for other referent types)
161+
:class:`Foo` - class Foo
162+
:meth:`Class.method1` - method1 in Class
163+
:meth:`~Class.method1` - method1 in Class, but rendered just as "method1()",
164+
not "Class.method1()"
165+
:meth:`title <method1>` - reference method1, but render as "title" (use only
166+
if really needed)
167+
:mod:`module1` - module module1
168+
169+
`symbol` - generic xref syntax which can replace any of the above in case
170+
the xref is unambiguous. If there's ambiguity, there will be a warning
171+
during docs generation, which need to be fixed using one of the syntaxes
172+
above
173+
```
174+
175+
* Cross-referencing arbitrary locations
176+
~~~
177+
.. _xref_target:
178+
179+
Normal non-indented text.
180+
181+
This is :ref:`reference <xref_target>`.
182+
183+
(If xref target is followed by section title, can be just
184+
:ref:`xref_target`).
185+
~~~
186+
187+
* Linking to external URL:
188+
```
189+
`link text <http://foo.com/...>`_
190+
```
191+
192+
* Referencing builtin singleton objects:
193+
```
194+
``None``, ``True``, ``False``
195+
```
196+
197+
* Use following syntax to create common description for more than one element:
198+
~~~
199+
.. function:: foo(x)
200+
bar(y)
201+
202+
Description common to foo() and bar().
203+
~~~
204+
205+
206+
More detailed guides and quickrefs:
207+
208+
* http://www.sphinx-doc.org/en/stable/rest.html
209+
* http://www.sphinx-doc.org/en/stable/markup/inline.html
210+
* http://docutils.sourceforge.net/docs/user/rst/quickref.html

‎README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,18 @@ Builtin modules include `sys`, `time`, and `struct`, etc. Select ports have
4747
support for `_thread` module (multithreading). Note that only a subset of
4848
Python 3 functionality is implemented for the data types and modules.
4949

50-
See the repository www.github.com/micropython/pyboard for the MicroPython
50+
MicroPython can execute scripts in textual source form or from precompiled
51+
bytecode, in both cases either from an on-device filesystem or "frozen" into
52+
the MicroPython executable.
53+
54+
See the repository http://github.com/micropython/pyboard for the MicroPython
5155
board (PyBoard), the officially supported reference electronic circuit board.
5256

5357
Major components in this repository:
5458
- py/ -- the core Python implementation, including compiler, runtime, and
5559
core library.
60+
- mpy-cross/ -- the MicroPython cross-compiler which is used to turn scripts
61+
into precompiled bytecode.
5662
- unix/ -- a version of MicroPython that runs on Unix.
5763
- stmhal/ -- a version of MicroPython that runs on the PyBoard and similar
5864
STM32 boards (using ST's Cube HAL drivers).

‎bare-arm/stm32f405.ld

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ MEMORY
1111
CCMRAM (xrw) : ORIGIN = 0x10000000, LENGTH = 0x010000 /* 64 KiB */
1212
RAM (xrw) : ORIGIN = 0x20000000, LENGTH = 0x020000 /* 128 KiB */
1313
}
14-
14+
1515
/* top end of the stack */
1616
_estack = ORIGIN(RAM) + LENGTH(RAM);
1717

@@ -30,7 +30,7 @@ SECTIONS
3030

3131
. = ALIGN(4);
3232
} >FLASH_ISR
33-
33+
3434
/* The program code and other data goes into FLASH */
3535
.text :
3636
{
@@ -46,7 +46,7 @@ SECTIONS
4646
_etext = .; /* define a global symbol at end of code */
4747
_sidata = _etext; /* This is used by the startup in order to initialize the .data secion */
4848
} >FLASH_TEXT
49-
49+
5050
/*
5151
.ARM.extab :
5252
{
@@ -60,7 +60,7 @@ SECTIONS
6060
__exidx_end = .;
6161
} >FLASH
6262
*/
63-
63+
6464
/* This is the initialized data section
6565
The program executes knowing that the data is in the RAM
6666
but the loader puts the initial values in the FLASH (inidata).
@@ -76,7 +76,7 @@ SECTIONS
7676
. = ALIGN(4);
7777
_edata = .; /* define a global symbol at data end; used by startup code in order to initialise the .data section in RAM */
7878
} >RAM
79-
79+
8080
/* Uninitialized data section */
8181
.bss :
8282
{

‎cc3200/bootmgr/bootmgr.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@
2323
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2424
* THE SOFTWARE.
2525
*/
26-
27-
#ifndef __BOOTMGR_H__
28-
#define __BOOTMGR_H__
26+
#ifndef MICROPY_INCLUDED_CC3200_BOOTMGR_BOOTMGR_H
27+
#define MICROPY_INCLUDED_CC3200_BOOTMGR_BOOTMGR_H
2928

3029
//****************************************************************************
3130
//
@@ -66,4 +65,4 @@ extern void Run(unsigned long);
6665
}
6766
#endif
6867

69-
#endif //__BOOTMGR_H__
68+
#endif // MICROPY_INCLUDED_CC3200_BOOTMGR_BOOTMGR_H

‎cc3200/bootmgr/flc.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@
2323
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2424
* THE SOFTWARE.
2525
*/
26-
27-
#ifndef __FLC_H__
28-
#define __FLC_H__
26+
#ifndef MICROPY_INCLUDED_CC3200_BOOTMGR_FLC_H
27+
#define MICROPY_INCLUDED_CC3200_BOOTMGR_FLC_H
2928

3029
/******************************************************************************
3130
@@ -93,4 +92,4 @@ typedef struct _sBootInfo_t
9392
}
9493
#endif
9594

96-
#endif /* __FLC_H__ */
95+
#endif // MICROPY_INCLUDED_CC3200_BOOTMGR_FLC_H

‎cc3200/ftp/ftp.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ void ftp_run (void) {
335335
ftp_data.loggin.uservalid = false;
336336
ftp_data.loggin.passvalid = false;
337337
strcpy (ftp_path, "/");
338-
ftp_send_reply (220, "Micropython FTP Server");
338+
ftp_send_reply (220, "MicroPython FTP Server");
339339
break;
340340
}
341341
}

‎cc3200/ftp/ftp.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@
2323
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2424
* THE SOFTWARE.
2525
*/
26-
27-
#ifndef FTP_H_
28-
#define FTP_H_
26+
#ifndef MICROPY_INCLUDED_CC3200_FTP_FTP_H
27+
#define MICROPY_INCLUDED_CC3200_FTP_FTP_H
2928

3029
/******************************************************************************
3130
DECLARE EXPORTED FUNCTIONS
@@ -36,4 +35,4 @@ extern void ftp_enable (void);
3635
extern void ftp_disable (void);
3736
extern void ftp_reset (void);
3837

39-
#endif /* FTP_H_ */
38+
#endif // MICROPY_INCLUDED_CC3200_FTP_FTP_H

‎cc3200/ftp/updater.h

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,8 @@
2323
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2424
* THE SOFTWARE.
2525
*/
26-
27-
28-
#ifndef UPDATER_H_
29-
#define UPDATER_H_
26+
#ifndef MICROPY_INCLUDED_CC3200_FTP_UPDATER_H
27+
#define MICROPY_INCLUDED_CC3200_FTP_UPDATER_H
3028

3129
extern void updater_pre_init (void);
3230
extern bool updater_check_path (void *path);
@@ -35,4 +33,4 @@ extern bool updater_write (uint8_t *buf, uint32_t len);
3533
extern void updater_finnish (void);
3634
extern bool updater_verify (uint8_t *rbuff, uint8_t *hasbuff);
3735

38-
#endif /* UPDATER_H_ */
36+
#endif // MICROPY_INCLUDED_CC3200_FTP_UPDATER_H

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy