summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2023-03-18 08:45:55 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2023-03-18 08:45:55 (GMT)
commit036b676c8b7295e2aa9324344d0ec1529ebb74ba (patch)
tree9fb4f3c7479278b307e890b2c021ee82b36cdf81 /doc
parent43218725b379e88dfb60a05f6ffa883b019e4036 (diff)
parent5fbaf44ecf9e3c77c88088e83c53b51cd8af05db (diff)
downloadtcl-036b676c8b7295e2aa9324344d0ec1529ebb74ba.zip
tcl-036b676c8b7295e2aa9324344d0ec1529ebb74ba.tar.gz
tcl-036b676c8b7295e2aa9324344d0ec1529ebb74ba.tar.bz2
Merge 8.7
Diffstat (limited to 'doc')
-rw-r--r--doc/Encoding.38
-rw-r--r--doc/encoding.n2
2 files changed, 4 insertions, 6 deletions
diff --git a/doc/Encoding.3 b/doc/Encoding.3
index 92268e8..2e50416 100644
--- a/doc/Encoding.3
+++ b/doc/Encoding.3
@@ -211,7 +211,6 @@ call \fBTcl_DStringFree\fR to free any information stored in \fIdstPtr\fR.
When converting, if any of the characters in the source buffer cannot be
represented in the target encoding, a default fallback character will be
used. The return value is a pointer to the value stored in the DString.
-
.PP
\fBTcl_ExternalToUtfDStringEx\fR is a more flexible version of older
\fBTcl_ExternalToUtfDString\fR function. It takes three additional parameters,
@@ -223,7 +222,7 @@ into the function. On success, the function returns \fBTCL_ERROR\fR with the
converted string stored in \fB*dstPtr\fR. For errors other than conversion
errors, such as invalid flags, the function returns \fBTCL_OK\fR with an error
message in \fBinterp\fR if it is not NULL.
-
+.PP
For conversion errors, \fBTcl_ExternalToUtfDStringEx\fR returns one
of the \fBTCL_CONVERT_*\fR errors listed below for \fBTcl_ExternalToUtf\fR.
When one of these conversion errors is returned, an error message is
@@ -231,10 +230,9 @@ stored in \fBinterp\fR only if \fBerrorIdxPtr\fR is NULL. Otherwise, no error me
is stored as the function expects the caller is interested whatever is
decoded to that point and not treating this as an immediate error condition.
The index of the error location is stored in \fB*errorIdxPtr\fR.
-
+.PP
The caller must call \fBTcl_DStringFree\fR to free up the \fB*dstPtr\fR resources
irrespective of the return value from the function.
-
.PP
\fBTcl_ExternalToUtf\fR converts a source buffer \fIsrc\fR from the specified
\fIencoding\fR into UTF-8. Up to \fIsrcLen\fR bytes are converted from the
@@ -593,7 +591,7 @@ with at most one of \fBTCL_ENCODING_PROFILE_TCL8\fR,
These correspond to the \fBtcl8\fR, \fBstrict\fR and \fBreplace\fR profiles
respectively. If none are specified, a version-dependent default profile is used.
For Tcl 8.7, the default profile is \fBtcl8\fR.
-
+.PP
For details about profiles, see the \fBPROFILES\fR section in
the documentation of the \fBencoding\fR command.
.SH "SEE ALSO"
diff --git a/doc/encoding.n b/doc/encoding.n
index 7266311..8ede974 100644
--- a/doc/encoding.n
+++ b/doc/encoding.n
@@ -85,8 +85,8 @@ The encodings
and
.QW iso8859-1
are guaranteed to be present in the list.
-.TP
.VS "TCL8.7 TIP656"
+.TP
\fBencoding profiles\fR
Returns a list of the names of encoding profiles. See \fBPROFILES\fR below.
.VE "TCL8.7 TIP656"