[pkgsrc/trunk]: pkgsrc/pkgtools/pkglint/files/doc Added an explanation for th...

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/062f9b647b79
branches:  trunk
changeset: 511212:062f9b647b79
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Tue Apr 11 18:41:50 2006 +0000

description:
Added an explanation for the state names of the patch file parser.

diffstat:

 pkgtools/pkglint/files/doc/chap.statemachines.xml |  14 +++++++++++++-
 1 files changed, 13 insertions(+), 1 deletions(-)

diffs (28 lines):

diff -r ee200b05d8fc -r 062f9b647b79 pkgtools/pkglint/files/doc/chap.statemachines.xml
--- a/pkgtools/pkglint/files/doc/chap.statemachines.xml Tue Apr 11 18:40:59 2006 +0000
+++ b/pkgtools/pkglint/files/doc/chap.statemachines.xml Tue Apr 11 18:41:50 2006 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: chap.statemachines.xml,v 1.1 2006/02/26 23:38:07 rillig Exp $ -->
+<!-- $NetBSD: chap.statemachines.xml,v 1.2 2006/04/11 18:41:50 rillig Exp $ -->
 
 <chapter id="statemachines">
 <title>State machines</title>
@@ -60,6 +60,18 @@
        </mediaobject>
        </figure>
 
+       <para>The states on the left side are for parsing context diffs,
+       the ones on the right side are for unified diffs. Some of the
+       state names are highly abbreviated as follows. The first letter
+       gives the format of the patch, which is <quote>c</quote> for
+       context diffs and <quote>u</quote> for unified diffs. The second
+       letter gives the current syntactical level, which is
+       <quote>f</quote> for a file header, <quote>h</quote> for a hunk
+       header, or <quote>l</quote> for the hunk lines. The third letter
+       describes the action that belongs to the line, which is
+       <quote>a</quote> for an addition, and <quote>d</quote> for a
+       deletion.</para>
+
 </sect1>
 
 </chapter>