docs(web): write about the meta description of tags file format

Signed-off-by: Masatake YAMATO <yamato@redhat.com>
tony534 · May 18, 2018 · d3f580e · d3f580e
1 parent 7e45c1d
commit d3f580e
Showing 1 changed file with 13 additions and 9 deletions.
diff --git a/docs/format.rst b/docs/format.rst
@@ -6,9 +6,13 @@ Proposal for extended Vi tags file format
 
     The contents of next section is a copy of FORMAT file in exuberant
     ctags source code in its subversion repository at sourceforge.net.
-    I(Masatake YAMATO) changed only its format in the most of all
-    parts.  I added a subsection for showing the position of universal
-    ctags.
+
+	We have made some modifications:
+
+	* Exceptions introduced in Universal-ctags are explained with
+	  "EXCEPTION" marker.
+
+    * `Exceptions in Universal-ctags`_ subsction summarizes the exceptions.
 
 .. contents:: `Table of contents`
 	:depth: 3
@@ -100,7 +104,7 @@ This restricts the format to what Vi can handle.  The format is:
    {tagname}
 	Any identifier, not containing white space..
 
-	EXCEPTION: Universal ctags violates this item of the proposal;
+	EXCEPTION: Universal-ctags violates this item of the proposal;
 	tagname may contain spaces. However, tabs are not allowed.
 
    <Tab>
@@ -223,7 +227,7 @@ Use a comment after the {tagaddress} field.  The format would be::
 {tagname}
 	Any identifier, not containing white space..
 
-	EXCEPTION: Universal ctags violates this item of the proposal;
+	EXCEPTION: Universal-ctags violates this item of the proposal;
 	name may contain spaces. However, tabs are not allowed.
 	Conversion, for some characters including <Tab> in the "value",
 	explained in the last of this section is applied.
@@ -268,7 +272,7 @@ A tagfield has a name, a colon, and a value: "name:value".
   Warning: When a tagfield value holds an MS-DOS file name, the backslashes
   must be doubled!
 
-  EXCEPTION: Universal ctags introduces more conversion rules.
+  EXCEPTION: Universal-ctags introduces more conversion rules.
 
   - When a value contains a "\\a", this stands for a <BEL> (0x07).
   - When a value contains a "\\b", this stands for a <BS> (0x08).
@@ -462,17 +466,17 @@ file, and provided solely for documentation purposes::
     !_TAG_PROGRAM_URL	{URL}	/optional comment/
     !_TAG_PROGRAM_VERSION	{version-id}	/optional comment/
 
-Universal ctags
+Exceptions in Universal-ctags
 --------------------------------
 
-Universal ctags supports this proposal with some
+Universal-ctags supports this proposal with some
 exceptions.
 
 
 Exceptions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-#. {tagname} in tags file generated by Universal ctags may contain
+#. {tagname} in tags file generated by Universal-ctags may contain
    spaces and several escape sequences. Parsers for documents like Tex and
    reStructuredText, or liberal languages such as JavaScript need these
    exceptions. See {tagname} of Proposal section for more detail about the