Skip to content

Commit

Permalink
Add some more links to tools/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
craigbarnes committed Jan 8, 2025
1 parent ea9824c commit 94d25d9
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@ dte tools
This directory contains several small scripts used for development
purposes and is *not* included in [releases]:

* `mk/*.mk`: Various `make` utility targets (see `make help` output)
* `mk/*.mk`: Various `make` utility targets (see [`make help`] output)
* `coccinelle/*.cocci`: [Coccinelle][] [semantic patches] used by the
[`make check-coccinelle`] target (to identify some codebase-specific
pitfalls or inefficiencies)
* `mock-headers/*.h`: Mock header files used by `make check-clang-tidy`,
* `mock-headers/*.h`: Mock header files used by [`make check-clang-tidy`],
in place of some generated (`build/gen/*.h`) headers
* `git-hooks/*`: See [`docs/contributing.md`] and [`githooks(5)`]
* `*.{sh,awk}`: See comments at the top of each script


[releases]: https://craigbarnes.gitlab.io/dte/releases.html
[`make help`]: mk/help.mk
[Coccinelle]: https://coccinelle.gitlabpages.inria.fr/website/
[semantic patches]: https://coccinelle.gitlabpages.inria.fr/website/sp.html
[`make check-coccinelle`]: mk/dev.mk
[`make check-coccinelle`]: mk/lint.mk
[`make check-clang-tidy`]: mk/clang-tidy.mk
[`docs/contributing.md`]: docs/contributing.md#merge-requests:~:text=make%20git-hooks
[`githooks(5)`]: https://man7.org/linux/man-pages/man5/githooks.5.html#HOOKS

0 comments on commit 94d25d9

Please sign in to comment.