Mercurial > ecos

changeset 2783:d4c7c6b285b6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Doc and CDL description fixes.
author bartv
date Mon, 09 Feb 2009 23:06:14 +0000
parents 188914a57f30
children 70c6da0cc793
files packages/io/spi/current/ChangeLog packages/io/spi/current/cdl/spi.cdl packages/io/spi/current/doc/spi.sgml
diffstat 3 files changed, 19 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/packages/io/spi/current/ChangeLog
+++ b/packages/io/spi/current/ChangeLog
@@ -1,3 +1,9 @@
+2009-02-09  Bart Veer  <bartv@ecoscentric.com>
+
+	* cdl/spi.cdl: fix descriptions in the CFLAGS_ADD and
+	CFLAGS_REMOVE options
+	* doc/spi.sgml: fix typo. Mention CYG_INIT_BUS_SPI priority.
+
 2008-12-30  John Dallaway  <john@dallaway.org.uk>
 
 	* cdl/spi.cdl: Reference per-package documentation.
@@ -16,7 +22,7 @@ 2004-04-23  Bart Veer  <bartv@ecoscentri
 // ####GPLCOPYRIGHTBEGIN####                                                
 // -------------------------------------------                              
 // This file is part of eCos, the Embedded Configurable Operating System.   
-// Copyright (C) 2004 Free Software Foundation, Inc.                        
+// Copyright (C) 2004, 2009 Free Software Foundation, Inc.                        
 //
 // This program is free software; you can redistribute it and/or modify     
 // it under the terms of the GNU General Public License as published by     
--- a/packages/io/spi/current/cdl/spi.cdl
+++ b/packages/io/spi/current/cdl/spi.cdl
@@ -8,7 +8,7 @@
 ## ####ECOSGPLCOPYRIGHTBEGIN####                                            
 ## -------------------------------------------                              
 ## This file is part of eCos, the Embedded Configurable Operating System.   
-## Copyright (C) 2004 Free Software Foundation, Inc.                        
+## Copyright (C) 2004, 2009 Free Software Foundation, Inc.                        
 ##
 ## eCos is free software; you can redistribute it and/or modify it under    
 ## the terms of the GNU General Public License as published by the Free     
@@ -58,15 +58,13 @@ cdl_package CYGPKG_IO_SPI {
         attached to an SPI bus. It also provides support for writing
         bus drivers and for defining SPI device structures."
 
-    
     cdl_component CYGPKG_IO_SPI_OPTIONS {
         display "SPI build options"
         flavor  none
         description   "
 	    Package specific build options including control over
-	    compiler flags used only in building this package,
-	    and details of which tests are built."
-
+	    compiler flags used only in building the generic SPI
+            package, and details of which tests are built."
 
         cdl_option CYGPKG_IO_SPI_CFLAGS_ADD {
             display "Additional compiler flags"
@@ -75,8 +73,8 @@ cdl_package CYGPKG_IO_SPI {
             default_value { "" }
             description   "
                 This option modifies the set of compiler flags for
-                building the serial device drivers. These flags are used in addition
-                to the set of global flags."
+                building the generic SPI package. These flags are 
+                used in addition to the set of global flags."
         }
 
         cdl_option CYGPKG_IO_SPI_CFLAGS_REMOVE {
@@ -86,8 +84,8 @@ cdl_package CYGPKG_IO_SPI {
             default_value { "" }
             description   "
                 This option modifies the set of compiler flags for
-                building the serial device drivers. These flags are removed from
-                the set of global flags if present."
+                building the generic SPI package. These flags are 
+                removed from the set of global flags if present."
         }
     }
 }
--- a/packages/io/spi/current/doc/spi.sgml
+++ b/packages/io/spi/current/doc/spi.sgml
@@ -11,7 +11,7 @@
 <!-- =============================================================== -->
 <!-- ####ECOSDOCCOPYRIGHTBEGIN####                                   -->
 <!-- =============================================================== -->
-<!-- Copyright (C) 2004 Free Software Foundation, Inc.               -->
+<!-- Copyright (C) 2004, 2009 Free Software Foundation, Inc.         -->
 <!-- This material may be distributed only subject to the terms      -->
 <!-- and conditions set forth in the Open Publication License, v1.0  -->
 <!-- or later (the latest version is presently available at          -->
@@ -203,8 +203,8 @@ extra functions in the platform HAL.
     <para>
 Typically all appropriate packages will be loaded automatically when
 you configure eCos for a given target. If the application does not use
-of the SPI I/O facilities, directly or indirectly, then linker garbage
-collection should eliminate all unnecessary code and data. All
+any of the SPI I/O facilities, directly or indirectly, then linker
+garbage collection should eliminate all unnecessary code and data. All
 necessary initialization should happen automatically. However the
 exact details may depend on the target, so the platform HAL
 documentation should be checked for further details.
@@ -689,7 +689,8 @@ Create a HAL table for the devices attac
       <listitem><para>
 Arrange for the bus to be initialized early on during system
 initialization. Typically this will happen via a prioritized static
-constructor. As part of this initialization the bus driver should
+constructor with priority <literal>CYG_INIT_BUS_SPI</literal>.
+As part of this initialization the bus driver should
 invoke the <function>CYG_SPI_BUS_COMMON_INIT</function> macro on its
 <structname>cyg_spi_bus</structname> field.
       </para></listitem>