[svn-commits] tzafrir: linux/trunk r8405 - /linux/trunk/README

[SVN commits to the Digium repositories]

Author: tzafrir
Date: Wed Mar 24 07:07:32 2010
New Revision: 8405

URL: http://svnview.digium.com/svn/dahdi?view=rev&rev=8405
Log:
document the header line of /proc/dahdi/NN

Modified:
    linux/trunk/README

Modified: linux/trunk/README
URL: http://svnview.digium.com/svn/dahdi/linux/trunk/README?view=diff&rev=8405&r1=8404&r2=8405
==============================================================================
--- linux/trunk/README (original)
+++ linux/trunk/README Wed Mar 24 07:07:32 2010
@@ -551,8 +551,9 @@
 loads. As each span registers to DAHDI, a file under /proc/dahdi is created
 for it. The name of that file is the number of that span.
 
-Each file has a 1-line title for the span followed by an empty line and
-then a line for each channel of the span. 
+Each file has a 1-line title for the span followed by a few optional
+general counter lines, an empty line and then a line for each channel of
+the span. 
 
 The title line shows the number of the span, its name and title, and 
 (potentially) the alarms in which it is.
@@ -562,6 +563,19 @@
 alarms):
 
   Span 1: XBUS-00/XPD-00 "Xorcom XPD #0/0: FXS"
+
+There are several extra optional keywords that may be added there:
+
+(Master)::
+  This span is the master span. See <<_dahdi_timing,DAHDI Timing>>.
+ClockSource::
+  The clock source among several spans that belong to a single E1/J1/T1
+  card.
+RED/YELLOW/RED/NOTOPEN/LOOP/RECOVERING::
+  The span is in alarm
+
+Following that line there may be some optional lines about IRQ misses,
+timing slips and such, if there are any.
 
 The channel line for each channel shows its channel number, name and the
 actual signalling assigned to it through dahdi_cfg. Before being configured by