13acefd99SMasatake YAMATO# -*- makefile -*- 2ed5c02c5SMasatake YAMATO.PHONY: help 3*6b86e373SHiroo HAYASHICTAGS_PROG = $(CTAGS_NAME_EXECUTABLE) 4*6b86e373SHiroo HAYASHI 5ed5c02c5SMasatake YAMATOhelp: 6ed5c02c5SMasatake YAMATO @echo "Compilation targets:" 7ed5c02c5SMasatake YAMATO @echo "" 8ed5c02c5SMasatake YAMATO @echo "make - Build $(CTAGS_PROG)" 9*6b86e373SHiroo HAYASHI @echo "make V=1 - Build $(CTAGS_PROG) with verbose output" 10ed5c02c5SMasatake YAMATO @echo "make -f mk_mingw.mak - Build $(CTAGS_PROG) using MinGW" 11*6b86e373SHiroo HAYASHI @echo "make -f mk_mingw.mak V=1 - Build $(CTAGS_PROG) using MinGW with verbose output" 12*6b86e373SHiroo HAYASHI @echo "make -C docs html - Build HTML documents by Sphinx" 13ed5c02c5SMasatake YAMATO @echo "" 14ed5c02c5SMasatake YAMATO @echo "Testing targets:" 15ed5c02c5SMasatake YAMATO @echo "" 16ed5c02c5SMasatake YAMATO @echo "make units - Run parser unit test cases" 17ed5c02c5SMasatake YAMATO @echo "make tmain - Run ctags main functionality test cases" 18*6b86e373SHiroo HAYASHI @echo "make tlib - Run mini-geany test cases" 19*6b86e373SHiroo HAYASHI @echo "make man-test - Run testing examples in per-language man pages" 20*6b86e373SHiroo HAYASHI @echo "make check-genfile - Run testing generated files are committed" 21*6b86e373SHiroo HAYASHI @echo "make check - Run all tests above" 22*6b86e373SHiroo HAYASHI @echo "" 23ed5c02c5SMasatake YAMATO @echo "make fuzz - Verify that all parsers are able to properly process each available test unit" 24971791e0SDoug Kearns @echo "make noise - Verify the behavior of parsers for broken input: a character injected or removed randomly" 25a379e1ccSMasatake YAMATO @echo "make chop - Verify the behavior of parsers for broken input: randomly truncated from tail" 26a379e1ccSMasatake YAMATO @echo "make slap - Verify the behavior of parsers for broken input: randomly truncated from head" 27971791e0SDoug Kearns @echo "make roundtrip - Verify the behavior of readtags command" 28ed5c02c5SMasatake YAMATO @echo 29ed5c02c5SMasatake YAMATO @echo "Arguments that can be used in testing targets:" 30*6b86e373SHiroo HAYASHI @echo 31*6b86e373SHiroo HAYASHI @echo "V=1 - Verbose output" 32ed5c02c5SMasatake YAMATO @echo "VG=1 - Run test cases with Valgrind memory profiler" 33ed5c02c5SMasatake YAMATO @echo "LANGUAGES=<language>[,<language>] - Only run test cases of the selected languages" 34ed5c02c5SMasatake YAMATO @echo "CATEGORIES=<category> - Only run tests available under folder Units/<category>.r" 359e5ade65SMasatake YAMATO @echo "UNITS=<case>[,<case>] - Only run tests named Units/[category.r/]/<case>.d in units target" 369e5ade65SMasatake YAMATO @echo " Tmain/<case>.d in tmain target" 37a3f9ddccSMasatake YAMATO @echo "PMAP=<newlang>/<oldlang>[,...] - Make <newlang> parser pretend <oldlang> (units target only)" 383b27c41cSMasatake YAMATO @echo "" 39e5399325SMasatake YAMATO @echo "Input validation target:" 403b27c41cSMasatake YAMATO @echo "" 41e5399325SMasatake YAMATO @echo "make validate-input - Validate the input files themselves, not ctags" 423b27c41cSMasatake YAMATO @echo 43e5399325SMasatake YAMATO @echo "Arguments that can be used in input validation target:" 44e5399325SMasatake YAMATO @echo "VALIDATORS=<validator>,[<validator>] - Validate only input files expecting validated by VALIDATORs" 45