Skip to content

Commit

Permalink
Document generating ctags tests using the pretty-printing script
Browse files Browse the repository at this point in the history
  • Loading branch information
techee committed Jan 1, 2023
1 parent bb45e3b commit 770a0db
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions HACKING
Original file line number Diff line number Diff line change
Expand Up @@ -699,9 +699,13 @@ It can be either long or short, depending on what it tests.

The expected output should be in the file ``tests/ctags/mytest.ext.tags``
(which is the same name as the source, but with ``.tags`` appended), and
should be in the format generated by ``geany -g``. This file contains
the tag information expected to be generated from the corresponding
source file.
should be in the format generated by::

$ geany -g tmp.ext.tags tests/ctags/mytest.ext
$ scripts/print-tags.py < tmp.ext.tags > tests/ctags/mytest.ext.tags

This file contains the tag information expected to be generated from
the corresponding source file together with its human-readable form.

When you have these two files, you have to list your new test along the
other ones in the ``test_source`` variable in ``tests/ctags/Makefile.am``.
Expand Down

0 comments on commit 770a0db

Please sign in to comment.