[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[avr-libc-commit] [2143] Various documentation fixes, mostly cosmetic.
From: |
Joerg Wunsch |
Subject: |
[avr-libc-commit] [2143] Various documentation fixes, mostly cosmetic. |
Date: |
Tue, 08 Jun 2010 21:19:51 +0000 |
Revision: 2143
http://svn.sv.gnu.org/viewvc/?view=rev&root=avr-libc&revision=2143
Author: joerg_wunsch
Date: 2010-06-08 21:19:51 +0000 (Tue, 08 Jun 2010)
Log Message:
-----------
Various documentation fixes, mostly cosmetic.
* include/avr/cpufunc.h: Fix doc grouping.
* include/util/delay_basic.h: Slightly reorder, so it actually
generates documentation again.
* doc/api/rel-method.dox: Update for our SVN repository.
* doc/api/malloc.dox: Fix doxygen warning.
* doc/api/tools-install.dox: (Ditto.)
* doc/api/faq.dox: (Ditto.)
Modified Paths:
--------------
trunk/avr-libc/ChangeLog
trunk/avr-libc/doc/api/faq.dox
trunk/avr-libc/doc/api/malloc.dox
trunk/avr-libc/doc/api/rel-method.dox
trunk/avr-libc/doc/api/tools-install.dox
trunk/avr-libc/include/avr/cpufunc.h
trunk/avr-libc/include/util/delay_basic.h
Modified: trunk/avr-libc/ChangeLog
===================================================================
--- trunk/avr-libc/ChangeLog 2010-06-08 20:13:54 UTC (rev 2142)
+++ trunk/avr-libc/ChangeLog 2010-06-08 21:19:51 UTC (rev 2143)
@@ -1,5 +1,16 @@
2010-06-08 Joerg Wunsch <address@hidden>
+ Various documentation fixes, mostly cosmetic.
+ * include/avr/cpufunc.h: Fix doc grouping.
+ * include/util/delay_basic.h: Slightly reorder, so it actually
+ generates documentation again.
+ * doc/api/rel-method.dox: Update for our SVN repository.
+ * doc/api/malloc.dox: Fix doxygen warning.
+ * doc/api/tools-install.dox: (Ditto.)
+ * doc/api/faq.dox: (Ditto.)
+
+2010-06-08 Joerg Wunsch <address@hidden>
+
bug #30085: memcpy_P on XMega does not clr NVM.CMD before copy
* include/avr/pgmspace.h: Mention that for Xmega devices,
these functions require NVM.CMD being set to 0x00.
Modified: trunk/avr-libc/doc/api/faq.dox
===================================================================
--- trunk/avr-libc/doc/api/faq.dox 2010-06-08 20:13:54 UTC (rev 2142)
+++ trunk/avr-libc/doc/api/faq.dox 2010-06-08 21:19:51 UTC (rev 2143)
@@ -1584,7 +1584,7 @@
</tr>
</table>
-\q *** It's not clear one would ever want to do character
+\note It's not clear one would ever want to do character
input simultaneously from more than one thread anyway, but
these entries are included for completeness.
Modified: trunk/avr-libc/doc/api/malloc.dox
===================================================================
--- trunk/avr-libc/doc/api/malloc.dox 2010-06-08 20:13:54 UTC (rev 2142)
+++ trunk/avr-libc/doc/api/malloc.dox 2010-06-08 21:19:51 UTC (rev 2143)
@@ -131,8 +131,8 @@
See the chapter about \ref gcc_minusW "using gcc" for the \c -Wl
options.
-\note The ld (linker) user manual states that using -Tdata=<x> is equivalent
-to using --section-start,.data=<x>. However, you have to use --section-start
+\note The ld (linker) user manual states that using -Tdata=<x> is
equivalent
+to using --section-start,.data=<x>. However, you have to use
--section-start
as above because the GCC frontend also sets the -Tdata option for
all MCU types where the SRAM doesn't start at 0x800060. Thus, the linker
is being faced with two -Tdata options. Sarting with binutils 2.16, the linker
Modified: trunk/avr-libc/doc/api/rel-method.dox
===================================================================
--- trunk/avr-libc/doc/api/rel-method.dox 2010-06-08 20:13:54 UTC (rev
2142)
+++ trunk/avr-libc/doc/api/rel-method.dox 2010-06-08 21:19:51 UTC (rev
2143)
@@ -83,23 +83,24 @@
\subsection release_branch Creating a cvs branch
-The following steps should be taken to cut a branch in cvs:
+The following steps should be taken to cut a branch in SVN (assuming
+$username is set to your savannah username):
-# Check out a fresh source tree from cvs HEAD.
-# Update the NEWS file with pending release number and commit to cvs HEAD:<br>
Change "Changes since avr-libc-\<last_release\>:" to
"Changes in avr-libc-\<this_relelase\>:".
-# Set the branch-point tag (setting \<major\> and \<minor\> accordingly):<br>
- 'cvs tag avr-libc-\<major\>_\<minor\>-branchpoint'
+ 'svn copy svn+ssh://address@hidden/avr-libc/trunk
svn+ssh://address@hidden/avr-libc/tags/avr-libc-\<major\>_\<minor\>-branchpoint'
-# Create the branch:<br>
- 'cvs tag -b avr-libc-\<major\>_\<minor\>-branch'
+ 'svn copy svn+ssh://address@hidden/avr-libc/trunk
svn+ssh://address@hidden/avr-libc/branches/avr-libc-\<major\>_\<minor\>-branch'
-# Update the package version in configure.ac and commit configure.ac to cvs
HEAD:<br>
Change minor number to next odd value.
-# Update the NEWS file and commit to cvs HEAD:<br>
Add "Changes since avr-libc-\<this_release\>:"
-# Check out a new tree for the branch:<br>
- 'cvs co -r avr-libc-\<major\>_\<minor\>-branch'
+ 'svn co
svn+ssh://address@hidden/avr-libc/tags/avr-libc-\<major\>_\<minor\>-branch'
-# Update the package version in configure.ac and commit configure.ac to cvs
branch:<br>
Change the patch number to 90 to denote that this now a branch leading up
@@ -123,7 +124,7 @@
The following steps should be taken when making a release:
-# Make sure the source tree you are working from is on the correct branch:<br>
- 'cvs update -r avr-libc-\<major\>_\<minor\>-branch'
+ 'svn switch
svn+ssh://address@hidden/avr-libc/tags/avr-libc-\<major\>_\<minor\>-branch'
-# Update the package version in configure.ac and commit it to cvs.
-# Update the gnu tool chain version requirements in the README and commit
to cvs.
@@ -137,7 +138,9 @@
-# Perform a 'make distcheck' and make sure it succeeds. This will create the
source tarball.
-# Tag the release:<br>
- 'cvs tag avr-libc-\<major\>_\<minor\>_\<patch\>-release'
+ 'svn copy .
svn+ssh://address@hidden/avr-libc/tags/avr-libc-\<major\>_\<minor\>_\<patch\>-release'<br>
+ or<br>
+ 'svn copy
svn+ssh://address@hidden/avr-libc/tags/avr-libc-\<major\>_\<minor\>-branch
svn+ssh://address@hidden/avr-libc/tags/avr-libc-\<major\>_\<minor\>_\<patch\>-release'
-# Upload the tarball to savannah.
-# Update the NEWS file, and commit to cvs:<br>
Add "Changes since avr-libc-\<major\>_\<minor\>_\<patch\>:"
Modified: trunk/avr-libc/doc/api/tools-install.dox
===================================================================
--- trunk/avr-libc/doc/api/tools-install.dox 2010-06-08 20:13:54 UTC (rev
2142)
+++ trunk/avr-libc/doc/api/tools-install.dox 2010-06-08 21:19:51 UTC (rev
2143)
@@ -513,7 +513,7 @@
- Version 8.63
- <http://www.cs.wisc.edu/~ghost/>
- Download and install.
- - In the \bin subdirectory of the installaion, copy gswin32c.exe to gs.exe.
+ - In the \\bin subdirectory of the installaion, copy gswin32c.exe to
gs.exe.
- Set the TEMP and TMP environment variables to <b>c:\\temp</b> or to the
short filename
version. This helps to avoid NTVDM errors during building.
Modified: trunk/avr-libc/include/avr/cpufunc.h
===================================================================
--- trunk/avr-libc/include/avr/cpufunc.h 2010-06-08 20:13:54 UTC (rev
2142)
+++ trunk/avr-libc/include/avr/cpufunc.h 2010-06-08 21:19:51 UTC (rev
2143)
@@ -44,10 +44,11 @@
*/
-/** \ingroup avr_cpufunc */
-/address@hidden/
#if defined(__DOXYGEN__)
/**
+ \ingroup avr_cpufunc
+ \def _NOP
+
Execute a <i>no operation</i> (NOP) CPU instruction. This
should not be used to implement delays, better use the functions
from <util/delay_basic.h> or <util/delay.h> for this. For
@@ -62,6 +63,9 @@
#if defined(__DOXYGEN__)
/**
+ \ingroup avr_cpufunc
+ \def _MemoryBarrier
+
Implement a read/write <i>memory barrier</i>. A memory
barrier instructs the compiler to not cache any memory data in
registers beyond the barrier. This can sometimes be more effective
@@ -73,6 +77,4 @@
#define _MemoryBarrier() __asm__ __volatile__(:::"memory")
#endif /* __DOXYGEN__ */
-/address@hidden/
-
#endif /* _AVR_CPUFUNC_H_ */
Modified: trunk/avr-libc/include/util/delay_basic.h
===================================================================
--- trunk/avr-libc/include/util/delay_basic.h 2010-06-08 20:13:54 UTC (rev
2142)
+++ trunk/avr-libc/include/util/delay_basic.h 2010-06-08 21:19:51 UTC (rev
2143)
@@ -36,6 +36,11 @@
#include <inttypes.h>
+#if !defined(__DOXYGEN__)
+static inline void _delay_loop_1(uint8_t __count)
__attribute__((always_inline));
+static inline void _delay_loop_2(uint16_t __count)
__attribute__((always_inline));
+#endif
+
/** \file */
/** \defgroup util_delay_basic <util/delay_basic.h>: Basic busy-wait delay
loops
\code
@@ -61,11 +66,6 @@
*/
-#if !defined(__DOXYGEN__)
-static inline void _delay_loop_1(uint8_t __count)
__attribute__((always_inline));
-static inline void _delay_loop_2(uint16_t __count)
__attribute__((always_inline));
-#endif
-
/** \ingroup util_delay_basic
Delay loop using an 8-bit counter \c __count, so up to 256
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [avr-libc-commit] [2143] Various documentation fixes, mostly cosmetic.,
Joerg Wunsch <=