Wyatt Hepler | f9fb90f | 2020-09-30 18:59:33 -0700 | [diff] [blame] | 1 | .. _module-pw_module: |
Alexei Frolov | b3f7fda | 2020-03-18 14:59:20 -0700 | [diff] [blame] | 2 | |
Keir Mierle | c34f71f | 2019-12-06 12:44:47 -0800 | [diff] [blame] | 3 | --------- |
| 4 | pw_module |
| 5 | --------- |
Alexei Frolov | b3f7fda | 2020-03-18 14:59:20 -0700 | [diff] [blame] | 6 | The ``pw_module`` module contains tools for managing Pigweed modules. |
| 7 | For information on the structure of a Pigweed module, refer to |
Wyatt Hepler | f9fb90f | 2020-09-30 18:59:33 -0700 | [diff] [blame] | 8 | :ref:`docs-module-guides`. |
Keir Mierle | c34f71f | 2019-12-06 12:44:47 -0800 | [diff] [blame] | 9 | |
Alexei Frolov | b3f7fda | 2020-03-18 14:59:20 -0700 | [diff] [blame] | 10 | Commands |
| 11 | -------- |
Keir Mierle | c34f71f | 2019-12-06 12:44:47 -0800 | [diff] [blame] | 12 | |
Wyatt Hepler | f9fb90f | 2020-09-30 18:59:33 -0700 | [diff] [blame] | 13 | .. _module-pw_module-module-check: |
Keir Mierle | c34f71f | 2019-12-06 12:44:47 -0800 | [diff] [blame] | 14 | |
Alexei Frolov | b3f7fda | 2020-03-18 14:59:20 -0700 | [diff] [blame] | 15 | ``pw module-check`` |
| 16 | ^^^^^^^^^^^^^^^^^^^ |
Keir Mierle | c34f71f | 2019-12-06 12:44:47 -0800 | [diff] [blame] | 17 | The ``pw module-check`` command exists to ensure that your module conforms to |
| 18 | the Pigweed module norms. |
| 19 | |
| 20 | For example, at time of writing ``pw module-check pw_module`` is not passing |
| 21 | its own lint: |
| 22 | |
| 23 | .. code-block:: none |
| 24 | |
| 25 | $ pw module-check pw_module |
| 26 | |
| 27 | ▒█████▄ █▓ ▄███▒ ▒█ ▒█ ░▓████▒ ░▓████▒ ▒▓████▄ |
| 28 | ▒█░ █░ ░█▒ ██▒ ▀█▒ ▒█░ █ ▒█ ▒█ ▀ ▒█ ▀ ▒█ ▀█▌ |
| 29 | ▒█▄▄▄█░ ░█▒ █▓░ ▄▄░ ▒█░ █ ▒█ ▒███ ▒███ ░█ █▌ |
| 30 | ▒█▀ ░█░ ▓█ █▓ ░█░ █ ▒█ ▒█ ▄ ▒█ ▄ ░█ ▄█▌ |
| 31 | ▒█ ░█░ ░▓███▀ ▒█▓▀▓█░ ░▓████▒ ░▓████▒ ▒▓████▀ |
| 32 | |
| 33 | 20191205 17:05:19 INF Checking module: pw_module |
| 34 | 20191205 17:05:19 ERR PWCK005: Missing ReST documentation; need at least e.g. "docs.rst" |
| 35 | 20191205 17:05:19 ERR FAIL: Found errors when checking module pw_module |
| 36 | |
| 37 | |