From 7da29d3d5fe2eb94e4e36802cb5a33b9652baad5 Mon Sep 17 00:00:00 2001
From: Karl Palsson <karlp@tweak.net.au>
Date: Tue, 28 Jan 2020 23:03:39 +0000
Subject: [PATCH] stm32: desig: doc: merge duplicate documentation sections

Use the best one.
---
 include/libopencm3/stm32/desig.h | 18 +++++++++++++-----
 lib/stm32/desig.c                | 12 ------------
 2 files changed, 13 insertions(+), 17 deletions(-)

diff --git a/include/libopencm3/stm32/desig.h b/include/libopencm3/stm32/desig.h
index f181cbc6..55e0045c 100644
--- a/include/libopencm3/stm32/desig.h
+++ b/include/libopencm3/stm32/desig.h
@@ -52,11 +52,19 @@ void desig_get_unique_id(uint32_t *result);
 void desig_get_unique_id_as_string(char *string,
 				   unsigned int string_len);
 
-/** 
- * Returns the same serial number that the factory DFU 
- * bootloader reports (via USB descriptors). 
- * @param string memory region to write the result to. This is 
- *        expected to be a 13-byte buffer.
+/**
+ * Generate the same serial number from the unique id registers as
+ * the DFU bootloader.
+ *
+ * This document: http://www.usb.org/developers/docs/devclass_docs/usbmassbulk_10.pdf
+ * says that the serial number has to be at least 12 digits long and that
+ * the last 12 digits need to be unique. It also stipulates that the valid
+ * character set is that of upper-case hexadecimal digits.
+ * The onboard DFU bootloader produces a 12-digit serial based on the
+ * 96-bit unique ID. Show the serial with ```dfu-util -l``` while the
+ * MCU is in DFU mode.
+ * @see https://my.st.com/52d187b7 for the algorithim used.
+ * @param string pointer to store serial in, must be at least 13 bytes
  */
 void desig_get_unique_id_as_dfu(char *string);
 
diff --git a/lib/stm32/desig.c b/lib/stm32/desig.c
index 272bfcb0..80665c6b 100644
--- a/lib/stm32/desig.c
+++ b/lib/stm32/desig.c
@@ -53,18 +53,6 @@ void desig_get_unique_id_as_string(char *string,
 	string[len] = '\0';
 }
 
-/**
- * Generate a serial number from the unique id registers as the DFU bootloader.
- * This document: http://www.usb.org/developers/docs/devclass_docs/usbmassbulk_10.pdf
- * says that the serial number has to be at least 12 digits long and that
- * the last 12 digits need to be unique. It also stipulates that the valid
- * character set is that of upper-case hexadecimal digits.
- * The onboard DFU bootloader produces a 12-digit serial based on the
- * 96-bit unique ID. Show the serial with ```dfu-util -l``` while the
- * MCU is in DFU mode.
- * @see https://my.st.com/52d187b7 for the algorithim used.
- * @param string pointer to store serial in, must be at least 13 bytes
- */
 void desig_get_unique_id_as_dfu(char *string) {
 	uint8_t *id = (uint8_t *)DESIG_UNIQUE_ID_BASE;