[LTP] [PATCH v2 3/8] doc: Add rules and recommendations list

Petr Vorel
2021-07-14T10:54:11Z

Hi Richie,

> +++ b/doc/test-writing-guidelines.txt
> @@ -10,6 +10,11 @@ NOTE: See also
> https://github.com/linux-test-project/ltp/wiki/Shell-Test-API[Shell Test API],
> https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines].

> +Rules and recommendations which are "machine checkable" should be
> +tagged with an ID like +LTP-XXX+. There will be a corresponding entry
> +in 'doc/rules.tsv'. When you run 'make check' or 'make check-test' it
> +will display these IDs as a reference.
> +
Actually text is on the top. I suppose, you probably planned to put this into "2.1 C coding style".

Kind regards,
Petr

> 1. Guide to clean and understandable code
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~