diff options
| author | Michael Olbrich <m.olbrich@pengutronix.de> | 2021-02-05 09:03:45 +0100 |
|---|---|---|
| committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2021-02-05 09:03:45 +0100 |
| commit | 45fb8f2a539a49aa3fcab03ace0d9ad61b3e9504 (patch) | |
| tree | e0138d043c8357106ac6b34831001a9b90ae9c6b /doc | |
| parent | c5a0eaeb1c7843353bcd54b9495591fabd78179d (diff) | |
| download | ptxdist-45fb8f2a539a49aa3fcab03ace0d9ad61b3e9504.tar.gz ptxdist-45fb8f2a539a49aa3fcab03ace0d9ad61b3e9504.tar.xz | |
doc: document 'lint'
Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing.rst | 6 | ||||
| -rw-r--r-- | doc/ref_parameter.rst | 5 |
2 files changed, 11 insertions, 0 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst index 705f01377..e51469d92 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -90,6 +90,12 @@ For new packages, the generated templates contain commented-out default sections. These are meant as a helper to simplify creating custom stages. Any remaining default stages must be removed. +All submissions should be checked with ``ptxdist lint``. It does basic +sanity checks and finds some typical errors. Old patches that where not +updated of removed after a version bump. Unknown PTXCONF_* variables or +macros used in menu files. There are often typos or the variables was just +removed. + Helper Scripts -------------- diff --git a/doc/ref_parameter.rst b/doc/ref_parameter.rst index 1d54fa4b4..a5b9bfe9e 100644 --- a/doc/ref_parameter.rst +++ b/doc/ref_parameter.rst @@ -250,6 +250,11 @@ Misc Actions For the specified package (or all selected packages), check the MD5 sums of license files. +``lint`` + check the BSP and PTXdist for all kinds of issues. These are not checks + for things that cause build errors. Instead the checks look for + inconsistencies that may cause hidden problems. + ``list-packages`` print a list of all selected packages. This list does not include the host and cross tools. |