aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJeff Garzik <jgarzik@pobox.com>2005-09-28 13:26:47 -0400
committerJeff Garzik <jgarzik@pobox.com>2005-09-28 13:26:47 -0400
commita1213499b0ef75d8c627b461047805a235c9dd00 (patch)
tree89b39cb950138db7c2f9d65b1abe14e8993e3bc1
parentbfd00722ac230a39bc5234c5f7a514ea6a77996d (diff)
libata: move EH docs to separate DocBook chapter
-rw-r--r--Documentation/DocBook/libata.tmpl30
1 files changed, 15 insertions, 15 deletions
diff --git a/Documentation/DocBook/libata.tmpl b/Documentation/DocBook/libata.tmpl
index fcbb58fc0fee..b2ec780bcda1 100644
--- a/Documentation/DocBook/libata.tmpl
+++ b/Documentation/DocBook/libata.tmpl
@@ -413,7 +413,9 @@ and other resources, etc.
413 </sect2> 413 </sect2>
414 414
415 </sect1> 415 </sect1>
416 <sect1> 416 </chapter>
417
418 <chapter id="libataEH">
417 <title>Error handling</title> 419 <title>Error handling</title>
418 420
419 <para> 421 <para>
@@ -422,7 +424,7 @@ and other resources, etc.
422 (Documentation/scsi/scsi_eh.txt) and ATA exceptions doc first. 424 (Documentation/scsi/scsi_eh.txt) and ATA exceptions doc first.
423 </para> 425 </para>
424 426
425 <sect2><title>Origins of commands</title> 427 <sect1><title>Origins of commands</title>
426 <para> 428 <para>
427 In libata, a command is represented with struct ata_queued_cmd 429 In libata, a command is represented with struct ata_queued_cmd
428 or qc. qc's are preallocated during port initialization and 430 or qc. qc's are preallocated during port initialization and
@@ -437,9 +439,9 @@ and other resources, etc.
437 and commands for SCSI emulation are passed as SCSI commands 439 and commands for SCSI emulation are passed as SCSI commands
438 through queuecommand callback of SCSI host template. 440 through queuecommand callback of SCSI host template.
439 </para> 441 </para>
440 </sect2> 442 </sect1>
441 443
442 <sect2><title>How commands are issued</title> 444 <sect1><title>How commands are issued</title>
443 445
444 <variablelist> 446 <variablelist>
445 447
@@ -501,9 +503,9 @@ and other resources, etc.
501 </varlistentry> 503 </varlistentry>
502 504
503 </variablelist> 505 </variablelist>
504 </sect2> 506 </sect1>
505 507
506 <sect2><title>How commands are processed</title> 508 <sect1><title>How commands are processed</title>
507 <para> 509 <para>
508 Depending on which protocol and which controller are used, 510 Depending on which protocol and which controller are used,
509 commands are processed differently. For the purpose of 511 commands are processed differently. For the purpose of
@@ -562,9 +564,9 @@ and other resources, etc.
562 </listitem> 564 </listitem>
563 </varlistentry> 565 </varlistentry>
564 </variablelist> 566 </variablelist>
565 </sect2> 567 </sect1>
566 568
567 <sect2><title>How commands are completed</title> 569 <sect1><title>How commands are completed</title>
568 <para> 570 <para>
569 Once issued, all qc's are either completed with 571 Once issued, all qc's are either completed with
570 ata_qc_complete() or time out. For commands which are handled 572 ata_qc_complete() or time out. For commands which are handled
@@ -660,9 +662,9 @@ and other resources, etc.
660 This leads us to ata_scsi_error() with partially completed qc. 662 This leads us to ata_scsi_error() with partially completed qc.
661 </para> 663 </para>
662 664
663 </sect2> 665 </sect1>
664 666
665 <sect2><title>ata_scsi_error()</title> 667 <sect1><title>ata_scsi_error()</title>
666 <para> 668 <para>
667 ata_scsi_error() is the current hostt->eh_strategy_handler() 669 ata_scsi_error() is the current hostt->eh_strategy_handler()
668 for libata. As discussed above, this will be entered in two 670 for libata. As discussed above, this will be entered in two
@@ -697,9 +699,9 @@ and other resources, etc.
697 to/cannot call ata_qc_complete() again. 699 to/cannot call ata_qc_complete() again.
698 </para> 700 </para>
699 701
700 </sect2> 702 </sect1>
701 703
702 <sect2><title>Problems with the current EH</title> 704 <sect1><title>Problems with the current EH</title>
703 705
704 <itemizedlist> 706 <itemizedlist>
705 707
@@ -766,9 +768,7 @@ and other resources, etc.
766 </listitem> 768 </listitem>
767 769
768 </itemizedlist> 770 </itemizedlist>
769 </sect2> 771 </sect1>
770
771 </sect1>
772 </chapter> 772 </chapter>
773 773
774 <chapter id="libataExt"> 774 <chapter id="libataExt">