Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: note that jansson is required for interactive mode #1669

Merged
merged 1 commit into from
Jan 26, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/interactive-mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ can be used programmatically to control ctags generation. In this mode, json
commands are received over stdin, and corresponding responses are emitted over
stdout.

This feature needs ctags to be built with json support and this requires libjansson to be installed
at build-time. If it's supported it will be listed in the output of ``--list-features``:

.. code-block:: console
$ ./ctags --list-features | grep json
json
Communication with Universal ctags over stdio uses the `json lines`_ format, where each
json object appears on a single line and is terminated with a newline.

Expand Down