Skip to content

Commit

Permalink
fixup! docs(man): write about the conditions when escaping rules are …
Browse files Browse the repository at this point in the history
…applied to input fields
  • Loading branch information
masatake committed Dec 30, 2022
1 parent 9f91d3e commit 91d65e4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions docs/man/readtags.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ human-readable, but when utilizing readtags output in a script or a client
tool, ``-E`` option should be used. See :ref:`ctags-client-tools(7) <ctags-client-tools(7)>` for more
discussion on this.

About printing input fields ({tagfile} in :ref:`tags(5) <tags(5)>`) with ``-E`` option:
readtags prints the input field literally (as it is in the tags file)
when ``TAG_OUTPUT_MODE`` pseudo tag has "u-ctags" and
``TAG_OUTPUT_FILESEP`` has "slash" as values for their input fields.
If this condition is not satisfied, readtags prints the fields with
unescaping. About the pseudo tags, see :ref:`ctags-client-tools(7) <ctags-client-tools(7)>`.
About printing input fields ({tagfile} in :ref:`tags(5) <tags(5)>`) with ``-E`` option: readtags
always prints the input field literally (as it is in the tags file), and when
ctags writes the tags file, the escaping rules are applied only when
``TAG_OUTPUT_MODE`` pseudo tag has "u-ctags" and ``TAG_OUTPUT_FILESEP`` has
"slash" as values for their input fields, as explained in
:ref:`ctags-client-tools(7) <ctags-client-tools(7)>`.

Filtering, Sorting, and Formatting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
12 changes: 6 additions & 6 deletions man/readtags.1.rst.in
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ human-readable, but when utilizing readtags output in a script or a client
tool, ``-E`` option should be used. See ctags-client-tools(7) for more
discussion on this.

About printing input fields ({tagfile} in tags(5)) with ``-E`` option:
readtags prints the input field literally (as it is in the tags file)
when ``TAG_OUTPUT_MODE`` pseudo tag has "u-ctags" and
``TAG_OUTPUT_FILESEP`` has "slash" as values for their input fields.
If this condition is not satisfied, readtags prints the fields with
unescaping. About the pseudo tags, see ctags-client-tools(7).
About printing input fields ({tagfile} in tags(5)) with ``-E`` option: readtags
always prints the input field literally (as it is in the tags file), and when
ctags writes the tags file, the escaping rules are applied only when
``TAG_OUTPUT_MODE`` pseudo tag has "u-ctags" and ``TAG_OUTPUT_FILESEP`` has
"slash" as values for their input fields, as explained in
ctags-client-tools(7).

Filtering, Sorting, and Formatting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 91d65e4

Please sign in to comment.