The patch titled
kernel-doc for lib/crc16.c lib/crc32.c lib/crc-ccitt.c
has been added to the -mm tree. Its filename is
kernel-doc-for-lib-crcc.patch
See http://www.zip.com.au/~akpm/linux/patches/stuff/added-to-mm.txt to find
out what to do about this
------------------------------------------------------
Subject: kernel-doc for lib/crc16.c lib/crc32.c lib/crc-ccitt.c
From: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
Make kernel-doc corrections & additions to lib/crc*.c. Add crc functions to
kernel-api.tmpl in DocBook.
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxx>
---
Documentation/DocBook/kernel-api.tmpl | 6 ++
lib/crc-ccitt.c | 6 +-
lib/crc16.c | 10 ++--
lib/crc32.c | 54 +++++++++---------------
4 files changed, 36 insertions(+), 40 deletions(-)
diff -puN Documentation/DocBook/kernel-api.tmpl~kernel-doc-for-lib-crcc Documentation/DocBook/kernel-api.tmpl
--- 25/Documentation/DocBook/kernel-api.tmpl~kernel-doc-for-lib-crcc Mon Jun 19 14:27:37 2006
+++ 25-akpm/Documentation/DocBook/kernel-api.tmpl Mon Jun 19 14:27:37 2006
@@ -129,6 +129,12 @@ X!Ilib/string.c
<sect1><title>Command-line Parsing</title>
!Elib/cmdline.c
</sect1>
+
+ <sect1><title>CRC Functions</title>
+!Elib/crc16.c
+!Elib/crc32.c
+!Elib/crc-ccitt.c
+ </sect1>
</chapter>
<chapter id="mm">
diff -puN lib/crc16.c~kernel-doc-for-lib-crcc lib/crc16.c
--- 25/lib/crc16.c~kernel-doc-for-lib-crcc Mon Jun 19 14:27:37 2006
+++ 25-akpm/lib/crc16.c Mon Jun 19 14:27:37 2006
@@ -47,12 +47,12 @@ u16 const crc16_table[256] = {
EXPORT_SYMBOL(crc16_table);
/**
- * Compute the CRC-16 for the data buffer
+ * crc16 - compute the CRC-16 for the data buffer
+ * @crc: previous CRC value
+ * @buffer: data pointer
+ * @len: number of bytes in the buffer
*
- * @param crc previous CRC value
- * @param buffer data pointer
- * @param len number of bytes in the buffer
- * @return the updated CRC value
+ * Returns the updated CRC value.
*/
u16 crc16(u16 crc, u8 const *buffer, size_t len)
{
diff -puN lib/crc32.c~kernel-doc-for-lib-crcc lib/crc32.c
--- 25/lib/crc32.c~kernel-doc-for-lib-crcc Mon Jun 19 14:27:37 2006
+++ 25-akpm/lib/crc32.c Mon Jun 19 14:27:37 2006
@@ -42,20 +42,21 @@ MODULE_AUTHOR("Matt Domsch <Matt_Domsch@
MODULE_DESCRIPTION("Ethernet CRC32 calculations");
MODULE_LICENSE("GPL");
+/**
+ * crc32_le() - Calculate bitwise little-endian Ethernet AUTODIN II CRC32
+ * @crc: seed value for computation. ~0 for Ethernet, sometimes 0 for
+ * other uses, or the previous crc32 value if computing incrementally.
+ * @p: pointer to buffer over which CRC is run
+ * @len: length of buffer @p
+ */
+u32 __attribute_pure__ crc32_le(u32 crc, unsigned char const *p, size_t len);
+
#if CRC_LE_BITS == 1
/*
* In fact, the table-based code will work in this case, but it can be
* simplified by inlining the table in ?: form.
*/
-/**
- * crc32_le() - Calculate bitwise little-endian Ethernet AUTODIN II CRC32
- * @crc - seed value for computation. ~0 for Ethernet, sometimes 0 for
- * other uses, or the previous crc32 value if computing incrementally.
- * @p - pointer to buffer over which CRC is run
- * @len - length of buffer @p
- *
- */
u32 __attribute_pure__ crc32_le(u32 crc, unsigned char const *p, size_t len)
{
int i;
@@ -68,14 +69,6 @@ u32 __attribute_pure__ crc32_le(u32 crc,
}
#else /* Table-based approach */
-/**
- * crc32_le() - Calculate bitwise little-endian Ethernet AUTODIN II CRC32
- * @crc - seed value for computation. ~0 for Ethernet, sometimes 0 for
- * other uses, or the previous crc32 value if computing incrementally.
- * @p - pointer to buffer over which CRC is run
- * @len - length of buffer @p
- *
- */
u32 __attribute_pure__ crc32_le(u32 crc, unsigned char const *p, size_t len)
{
# if CRC_LE_BITS == 8
@@ -145,20 +138,21 @@ u32 __attribute_pure__ crc32_le(u32 crc,
}
#endif
+/**
+ * crc32_be() - Calculate bitwise big-endian Ethernet AUTODIN II CRC32
+ * @crc: seed value for computation. ~0 for Ethernet, sometimes 0 for
+ * other uses, or the previous crc32 value if computing incrementally.
+ * @p: pointer to buffer over which CRC is run
+ * @len: length of buffer @p
+ */
+u32 __attribute_pure__ crc32_be(u32 crc, unsigned char const *p, size_t len);
+
#if CRC_BE_BITS == 1
/*
* In fact, the table-based code will work in this case, but it can be
* simplified by inlining the table in ?: form.
*/
-/**
- * crc32_be() - Calculate bitwise big-endian Ethernet AUTODIN II CRC32
- * @crc - seed value for computation. ~0 for Ethernet, sometimes 0 for
- * other uses, or the previous crc32 value if computing incrementally.
- * @p - pointer to buffer over which CRC is run
- * @len - length of buffer @p
- *
- */
u32 __attribute_pure__ crc32_be(u32 crc, unsigned char const *p, size_t len)
{
int i;
@@ -173,14 +167,6 @@ u32 __attribute_pure__ crc32_be(u32 crc,
}
#else /* Table-based approach */
-/**
- * crc32_be() - Calculate bitwise big-endian Ethernet AUTODIN II CRC32
- * @crc - seed value for computation. ~0 for Ethernet, sometimes 0 for
- * other uses, or the previous crc32 value if computing incrementally.
- * @p - pointer to buffer over which CRC is run
- * @len - length of buffer @p
- *
- */
u32 __attribute_pure__ crc32_be(u32 crc, unsigned char const *p, size_t len)
{
# if CRC_BE_BITS == 8
@@ -249,6 +235,10 @@ u32 __attribute_pure__ crc32_be(u32 crc,
}
#endif
+/**
+ * bitreverse - reverse the order of bits in a u32 value
+ * @x: value to be bit-reversed
+ */
u32 bitreverse(u32 x)
{
x = (x >> 16) | (x << 16);
diff -puN lib/crc-ccitt.c~kernel-doc-for-lib-crcc lib/crc-ccitt.c
--- 25/lib/crc-ccitt.c~kernel-doc-for-lib-crcc Mon Jun 19 14:27:37 2006
+++ 25-akpm/lib/crc-ccitt.c Mon Jun 19 14:27:37 2006
@@ -53,9 +53,9 @@ EXPORT_SYMBOL(crc_ccitt_table);
/**
* crc_ccitt - recompute the CRC for the data buffer
- * @crc - previous CRC value
- * @buffer - data pointer
- * @len - number of bytes in the buffer
+ * @crc: previous CRC value
+ * @buffer: data pointer
+ * @len: number of bytes in the buffer
*/
u16 crc_ccitt(u16 crc, u8 const *buffer, size_t len)
{
_
Patches currently in -mm which might be from rdunlap@xxxxxxxxxxxx are
git-alsa.patch
git-dvb.patch
git-infiniband.patch
git-kbuild.patch
git-mtd.patch
git-netdev-all.patch
git-pcmcia.patch
lpfc-sparse-null-warnings.patch
aic7-cleanup-module_parm_desc-strings.patch
qla1280-fix-section-mismatch-warnings.patch
areca-raid-linux-scsi-driver.patch
git-watchdog.patch
slab-kmalloc-kzalloc-comments-cleanup-and-fix.patch
kernel-doc-for-mm-filemapc.patch
add-poisonh-and-patch-primary-users.patch
update-2-drivers-for-poisonh.patch
poison-add-use-more-constants.patch
add-doc-submitchecklist.patch
doc-add-audit-acct-to-docbook.patch
codingstyle-add-typedefs-chapter.patch
fix-listh-kernel-doc.patch
listh-doc-change-counter-to-control.patch
kernel-doc-drop-leading-space-in-sections.patch
kernel-doc-script-cleanups.patch
wd7000-fix-section-mismatch-warnings.patch
megaraid_mbox-fix-section-mismatch-warnings.patch
kernel-doc-mm-readhead-fixup.patch
checkstack-pirnt-module-names.patch
wan-sdla-section-fixes.patch
trident-fb-section-fixes.patch
cdrom-mcdx-section-fixes.patch
char-ip2-more-section-fixes-replacement.patch
advansys-section-fixes.patch
kernel-doc-warn-on-malformed-function-docs.patch
ide-floppy-fix-debug-only-syntax-error.patch
kernel-doc-for-lib-bitmapc.patch
kernel-doc-for-lib-cmdlinec.patch
kernel-doc-for-lib-crcc.patch
pi-futex-rt-mutex-docs-update.patch
acpi-identify-which-device-is-not-power-manageable.patch
-
To unsubscribe from this list: send the line "unsubscribe mm-commits" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
