pw_module

Pigweed AI summary: The pw_module module provides tools for managing Pigweed modules, with information on the structure of a Pigweed module available in the Module Guides. The pw module check command ensures that a module conforms to Pigweed norms, with an example of the command not passing its own lint provided. The pw module create command generates the required boilerplate for a new Pigweed module, but is still experimental and subject to change.

The pw_module module contains tools for managing Pigweed modules. For information on the structure of a Pigweed module, refer to Module Guides.

Commands

Pigweed AI summary: The "pw module check" command checks if a module conforms to Pigweed module norms, but at the time of writing, it is not passing its own lint. The "pw module create" command generates the required boilerplate for a new Pigweed module, but it is still under construction and has limited feature support.

pw module check

Pigweed AI summary: The "pw module check" command is used to ensure that a module conforms to the Pigweed module norms. However, at the time of writing, the "pw module check pw_module" command is not passing its own lint due to missing ReST documentation.

The pw module check command exists to ensure that your module conforms to the Pigweed module norms.

For example, at time of writing pw module check pw_module is not passing its own lint:

$ pw module check pw_module

 ▒█████▄   █▓  ▄███▒  ▒█    ▒█ ░▓████▒ ░▓████▒ ▒▓████▄
  ▒█░  █░ ░█▒ ██▒ ▀█▒ ▒█░ █ ▒█  ▒█   ▀  ▒█   ▀  ▒█  ▀█▌
  ▒█▄▄▄█░ ░█▒ █▓░ ▄▄░ ▒█░ █ ▒█  ▒███    ▒███    ░█   █▌
  ▒█▀     ░█░ ▓█   █▓ ░█░ █ ▒█  ▒█   ▄  ▒█   ▄  ░█  ▄█▌
  ▒█      ░█░ ░▓███▀   ▒█▓▀▓█░ ░▓████▒ ░▓████▒ ▒▓████▀

20191205 17:05:19 INF Checking module: pw_module
20191205 17:05:19 ERR PWCK005: Missing ReST documentation; need at least e.g. "docs.rst"
20191205 17:05:19 ERR FAIL: Found errors when checking module pw_module

pw module create

Pigweed AI summary: The "pw module create" command is used to create the necessary boilerplate for a new Pigweed module. However, it is still under construction and experimental, with limited feature support and a command-line API subject to change. Once the command is more stable, it will be properly documented, but for now, running "pw module create --help" will display the current set of options.

The pw module create command is used to generate all of the required boilerplate for a new Pigweed module.

Note

pw module create is still under construction and mostly experimental. It is only usable in upstream Pigweed, and has limited feature support, with a command-line API subject to change.

Once the command is more stable, it will be properly documented. For now, running pw module create --help will display the current set of options.