From: Pádraig Brady <P@draigBrady.com>
Date: Sat, 18 Oct 2025 20:47:52 +0000 (+0100)
Subject: doc: mcel: give more detail on error interface
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=14dd80dba2d40e608492f0acbec6a90f6bf3877d;p=thirdparty%2Fgnulib.git

doc: mcel: give more detail on error interface

* lib/mcel.h: Mention that errors may be given on
some systems even with the "C" locale, as mcel
has explicitly disabled the workaround for:
https://sourceware.org/PR29511
Also state that len is set to 1 on any error.
---

diff --git a/ChangeLog b/ChangeLog
index 1d2195ca0f..13c9a9e96e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2025-11-01  Pádraig Brady  <P@draigBrady.com>
+
+	doc: mcel: give more detail on error interface
+	* lib/mcel.h: Mention that errors may be given on
+	some systems even with the "C" locale, as mcel
+	has explicitly disabled the workaround for:
+	https://sourceware.org/PR29511
+	Also state that len is set to 1 on any error.
+
 2025-11-01  Paul Eggert  <eggert@cs.ucla.edu>
 
 	nstrftime: do not return PTRDIFF_MAX
diff --git a/lib/mcel.h b/lib/mcel.h
index ebdd135f63..3e770c8c60 100644
--- a/lib/mcel.h
+++ b/lib/mcel.h
@@ -45,6 +45,8 @@
 
    You can select from G using G.ch, G.err, and G.len.
    G is an encoding error if G.err is nonzero, a character otherwise.
+   Note G.err may occur even in the "C" locale on some systems.
+   In any case G.len will be 1 if G.err is set.
 
    The mcel_scanz function is similar except it works with a
    string of unknown but positive length that is terminated with '\0'.