Skip to content

Commit

Permalink
documentation: Various doc tidyup
Browse files Browse the repository at this point in the history
configure.ac: Tidy up coap_defines.h generation

doc/upgrade_4.3.4_4.3.5.txt: Document upgrade requirements

doc/Makefile.am: Include upgrade_4.3.4_4.3.5.txt

cmake_coap_defines.h.in: Add brief description
src/coap_sha1.c: Add in brief description

Note: With Ubuntu 24.04.01, when running a2x, spurious entries
 <unknown>:1: SyntaxWarning: invalid escape sequence '\S'
occur. Fixed by asciidoc-py/asciidoc-py#267
  • Loading branch information
mrdeep1 committed Oct 5, 2024
1 parent 3cba297 commit 8e407cc
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 2 deletions.
5 changes: 5 additions & 0 deletions cmake_coap_defines.h.in
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
* of use.
*/

/**
* @file coap_defines.h
* @brief List of libcoap library build defines
*/

#ifndef COAP_DEFINES_H_
#define COAP_DEFINES_H_

Expand Down
4 changes: 3 additions & 1 deletion configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -1554,7 +1554,9 @@ else
fi

mkdir -p include/coap$LIBCOAP_API_VERSION
LT_TEMP=`grep -B2 " COAP_" coap_config.h > include/coap$LIBCOAP_API_VERSION/coap_defines.h`
head -19 cmake_coap_defines.h.in > include/coap$LIBCOAP_API_VERSION/coap_defines.h
LT_TEMP=`grep -B2 " COAP_" coap_config.h >> include/coap$LIBCOAP_API_VERSION/coap_defines.h`
tail -2 cmake_coap_defines.h.in >> include/coap$LIBCOAP_API_VERSION/coap_defines.h
if test "x$LT_TEMP" != "x" ; then
AC_MSG_ERROR([Unable to build coap_defines.h])
fi
3 changes: 2 additions & 1 deletion doc/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ EXTRA_DIST = \
upgrade_4.3.1_4.3.2.txt \
upgrade_4.3.2_4.3.3.txt \
upgrade_4.3.3_4.3.4.txt \
upgrade_4.3.4_4.3.5.txt \
main.md \
module_api_wrap.h

Expand Down Expand Up @@ -244,7 +245,7 @@ man-page-build: upg-page-build man-page-start
done

if BUILD_MANPAGES
UPG_LIST = upgrade_4.2.1_4.3.0.txt upgrade_4.3.0_4.3.1.txt upgrade_4.3.1_4.3.2.txt upgrade_4.3.2_4.3.3.txt upgrade_4.3.3_4.3.4.txt
UPG_LIST = upgrade_4.2.1_4.3.0.txt upgrade_4.3.0_4.3.1.txt upgrade_4.3.1_4.3.2.txt upgrade_4.3.2_4.3.3.txt upgrade_4.3.3_4.3.4.txt upgrade_4.3.4_4.3.5.txt

upg-page-build:
@for FILE in $(UPG_LIST) ; do \
Expand Down
5 changes: 5 additions & 0 deletions doc/upgrade_4.3.4_4.3.5.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Upgrade from 4.3.4 to 4.3.5

== Summary

No code or binary changes required.
5 changes: 5 additions & 0 deletions src/coap_sha1.c
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@
* Reformatted as appropriate.
*/

/**
* @file coap_sha1.c
* @brief SHA-1 handling functions
*/

#include "coap3/coap_libcoap_build.h"

#if COAP_WS_SUPPORT && !defined(COAP_WITH_LIBOPENSSL) && !defined(COAP_WITH_LIBGNUTLS) && !defined(COAP_WITH_LIBMBEDTLS) && !defined(COAP_WITH_LIBWOLFSSL)
Expand Down

0 comments on commit 8e407cc

Please sign in to comment.