changeset 2940:f89e0743ba67

* packages/kernel/current/doc/kernel.sgml: Indicate that cyg_alarm_initialize() takes an absolute trigger value. Issue reported by Grant Edwards. * packages/kernel/current/cdl/kernel.cdl: Reference the kernel instrumentation documentation. * doc/sgml/makamakefile: Update copyright dates.
author jld
date Thu, 25 Feb 2010 08:53:17 +0000
parents 2cf7405710b5
children a2b177b28c45
files doc/ChangeLog doc/sgml/makemakefile packages/kernel/current/ChangeLog packages/kernel/current/cdl/kernel.cdl packages/kernel/current/doc/kernel.sgml
diffstat 5 files changed, 17 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,7 @@
+2010-02-25  John Dallaway  <john@dallaway.org.uk>
+
+	* sgml/makemakefile: Update copyright dates.
+
 2009-08-24  Uwe Kindler <uwe_kindler@web.de>
 
 	* sgml/doclist: Add uSTL documentation.
--- a/doc/sgml/makemakefile
+++ b/doc/sgml/makemakefile
@@ -20,7 +20,7 @@ cat > makefile <<EOF
 # ####ECOSGPLCOPYRIGHTBEGIN####                                             
 # -------------------------------------------                               
 # This file is part of eCos, the Embedded Configurable Operating System.    
-# Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2009 Free Software Foundation, Inc.
+# Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2009, 2010 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      
@@ -122,6 +122,7 @@ cat >> ecos-ref.sgml <<EOF
       <year>2007</year>
       <year>2008</year>
       <year>2009</year>
+      <year>2010</year>
       <holder>Free Software Foundation, Inc.</holder>
     </copyright>
 
--- a/packages/kernel/current/ChangeLog
+++ b/packages/kernel/current/ChangeLog
@@ -1,3 +1,9 @@
+2010-02-25  John Dallaway  <john@dallaway.org.uk>
+
+	* doc/kernel.sgml: Indicate that cyg_alarm_initialize() takes an
+	absolute trigger value. Issue reported by Grant Edwards.
+	* cdl/kernel.cdl: Reference the kernel instrumentation documentation.
+
 2010-01-27  John Dallaway  <john@dallaway.org.uk>
 
 	* include/instrmnt.h: Add instrumentation macros for event flags and
--- a/packages/kernel/current/cdl/kernel.cdl
+++ b/packages/kernel/current/cdl/kernel.cdl
@@ -8,7 +8,7 @@
 ## ####ECOSGPLCOPYRIGHTBEGIN####                                            
 ## -------------------------------------------                              
 ## This file is part of eCos, the Embedded Configurable Operating System.   
-## Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
+## Copyright (C) 1998, 1999, 2000, 2001, 2002, 2010 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     
@@ -204,6 +204,7 @@ cdl_package CYGPKG_KERNEL {
     # ---------------------------------------------------------------------
     cdl_component CYGPKG_KERNEL_INSTRUMENT {
         display       "Kernel instrumentation"
+        doc           user-guide/kernel-instrumentation.html
         flavor        bool
         default_value 0
         description   "
--- a/packages/kernel/current/doc/kernel.sgml
+++ b/packages/kernel/current/doc/kernel.sgml
@@ -9,7 +9,7 @@
 <!-- =============================================================== -->
 <!-- ####ECOSDOCCOPYRIGHTBEGIN####                                       -->
 <!-- ===============================================================     -->
-<!-- Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2009 Free Software Foundation, Inc. -->
+<!-- Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2009, 2010 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              -->
@@ -2571,8 +2571,8 @@ avoids any need for dynamic memory alloc
 Once an alarm has been created a further call to
 <function>cyg_alarm_initialize</function> is needed to activate it.
 The first argument specifies the alarm. The second argument indicates
-the number of events, for example clock ticks, that need to occur
-before the alarm triggers. If the third argument is 0 then the alarm
+the absolute value of the attached counter which will result in the
+alarm being triggered. If the third argument is 0 then the alarm
 will only trigger once. A non-zero value specifies that the alarm
 should trigger repeatedly, with an interval of the specified number of
 events.