This patch corrects the documentation for cyg_alarm_initiialize() and adds a reference to the kernel instrumentation documentation. Checked-in.
John Dallaway eCos maintainer
Index: doc/ChangeLog =================================================================== RCS file: /cvs/ecos/ecos/doc/ChangeLog,v retrieving revision 1.38 diff -U5 -r1.38 ChangeLog --- doc/ChangeLog 27 Aug 2009 09:00:11 -0000 1.38 +++ doc/ChangeLog 25 Feb 2010 08:48:47 -0000 @@ -1,5 +1,9 @@ +2010-02-25 John Dallaway <[email protected]> + + * sgml/makemakefile: Update copyright dates. + 2009-08-24 Uwe Kindler <[email protected]> * sgml/doclist: Add uSTL documentation. * sgml/makemakefile: Update copyright dates. Index: doc/sgml/makemakefile =================================================================== RCS file: /cvs/ecos/ecos/doc/sgml/makemakefile,v retrieving revision 1.20 diff -U5 -r1.20 makemakefile --- doc/sgml/makemakefile 27 Aug 2009 09:00:11 -0000 1.20 +++ doc/sgml/makemakefile 25 Feb 2010 08:48:47 -0000 @@ -18,11 +18,11 @@ # #============================================================================= # ####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 # Software Foundation; either version 2 or (at your option) any later # version. @@ -120,10 +120,11 @@ <year>2005</year> <year>2006</year> <year>2007</year> <year>2008</year> <year>2009</year> + <year>2010</year> <holder>Free Software Foundation, Inc.</holder> </copyright> <legalnotice> <title>Documentation licensing terms</title> Index: packages/kernel/current/ChangeLog =================================================================== RCS file: /cvs/ecos/ecos/packages/kernel/current/ChangeLog,v retrieving revision 1.154 diff -U5 -r1.154 ChangeLog --- packages/kernel/current/ChangeLog 29 Jan 2010 15:06:38 -0000 1.154 +++ packages/kernel/current/ChangeLog 25 Feb 2010 08:48:50 -0000 @@ -1,5 +1,11 @@ +2010-02-25 John Dallaway <[email protected]> + + * 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 <[email protected]> * include/instrmnt.h: Add instrumentation macros for event flags and the bitmap scheduler. * include/instrument_desc.h: Regenerate. Index: packages/kernel/current/cdl/kernel.cdl =================================================================== RCS file: /cvs/ecos/ecos/packages/kernel/current/cdl/kernel.cdl,v retrieving revision 1.22 diff -U5 -r1.22 kernel.cdl --- packages/kernel/current/cdl/kernel.cdl 29 Jan 2009 17:49:50 -0000 1.22 +++ packages/kernel/current/cdl/kernel.cdl 25 Feb 2010 08:48:50 -0000 @@ -6,11 +6,11 @@ # # ==================================================================== ## ####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 ## Software Foundation; either version 2 or (at your option) any later ## version. @@ -202,10 +202,11 @@ } # --------------------------------------------------------------------- cdl_component CYGPKG_KERNEL_INSTRUMENT { display "Kernel instrumentation" + doc user-guide/kernel-instrumentation.html flavor bool default_value 0 description " The current release of the kernel contains an initial version of instrumentation support. The various parts of the kernel Index: packages/kernel/current/doc/kernel.sgml =================================================================== RCS file: /cvs/ecos/ecos/packages/kernel/current/doc/kernel.sgml,v retrieving revision 1.16 diff -U5 -r1.16 kernel.sgml --- packages/kernel/current/doc/kernel.sgml 24 Aug 2009 11:37:04 -0000 1.16 +++ packages/kernel/current/doc/kernel.sgml 25 Feb 2010 08:48:54 -0000 @@ -7,11 +7,11 @@ <!-- eCos kernel documentation. --> <!-- --> <!-- =============================================================== --> <!-- ####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 --> <!-- http://www.opencontent.org/openpub/) --> <!-- Distribution of the work or derivative of the work in any --> @@ -2569,12 +2569,12 @@ </para> <para> 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. </para> <para>
