From: Maria Matejka <mq@ucw.cz>
Date: Mon, 22 Dec 2025 22:27:27 +0000 (+0100)
Subject: Lib: Fix comments so that progdoc is deterministic
X-Git-Tag: v2.18~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ebe4c47ef2a7eea0ccd271e9ab45b6f1908098b3;p=thirdparty%2Fbird.git

Lib: Fix comments so that progdoc is deterministic

For some weird reason, the old Perl code behaves non-deterministically on
@foo() and there is no clear explanation why. The snails should not be there
anyway so removing them.
---

diff --git a/lib/mac.c b/lib/mac.c
index 6c9cc7438..f7be6ba7c 100644
--- a/lib/mac.c
+++ b/lib/mac.c
@@ -234,7 +234,7 @@ void mac_update(struct mac_context *ctx, const byte *data, uint datalen)
  * @ctx: MAC context
  *
  * Finish MAC computation and return a pointer to the result. No more
- * @mac_update() calls could be done, but the context may be reinitialized
+ * mac_update() calls could be done, but the context may be reinitialized
  * later.
  *
  * Note that the returned pointer points into data in the @ctx context. If it
@@ -249,7 +249,7 @@ byte *mac_final(struct mac_context *ctx)
  *
  * Cleanup MAC context after computation (by filling with zeros). Not strictly
  * necessary, just to erase sensitive data from stack. This also invalidates the
- * pointer returned by @mac_final().
+ * pointer returned by mac_final().
  */
 void mac_cleanup(struct mac_context *ctx)
 { DUMMY; }
diff --git a/lib/sha1.h b/lib/sha1.h
index 8666a6512..c24c7c7c0 100644
--- a/lib/sha1.h
+++ b/lib/sha1.h
@@ -40,12 +40,12 @@ void sha1_init(struct hash_context *ctx); /* Initialize new algorithm run in the
 /*
  * Push another @len bytes of data pointed to by @buf onto the SHA1 hash
  * currently in @ctx. You can call this any times you want on the same hash (and
- * you do not need to reinitialize it by @sha1_init()). It has the same effect
+ * you do not need to reinitialize it by sha1_init()). It has the same effect
  * as concatenating all the data together and passing them at once.
  */
 void sha1_update(struct hash_context *ctx, const byte *buf, uint len);
 /*
- * No more @sha1_update() calls will be done. This terminates the hash and
+ * No more sha1_update() calls will be done. This terminates the hash and
  * returns a pointer to it.
  *
  * Note that the pointer points into data in the @ctx context. If it ceases to