From bb3e4af18d9b71c3cf04ff2ae49768ce69d60e4b Mon Sep 17 00:00:00 2001 From: "jan.nijtmans" Date: Fri, 27 Jun 2025 07:16:03 +0000 Subject: Make all references to -DFOO compiler flags bold in documentation --- doc/ByteArrObj.3 | 2 +- doc/CrtAlias.3 | 2 +- doc/DictObj.3 | 2 +- doc/FileSystem.3 | 2 +- doc/ListObj.3 | 4 ++-- doc/ParseArgs.3 | 2 +- doc/SplitList.3 | 2 +- doc/SplitPath.3 | 2 +- doc/StringObj.3 | 2 +- doc/Tcl_Main.3 | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/ByteArrObj.3 b/doc/ByteArrObj.3 index 6306591..88c9580 100644 --- a/doc/ByteArrObj.3 +++ b/doc/ByteArrObj.3 @@ -47,7 +47,7 @@ Interpreter to use for error reporting. Points to space where the number of bytes in the array may be written. May be (Tcl_Size *)NULL when not used. If it points to a variable which type is not \fBTcl_Size\fR, a compiler warning will be generated. -If your extensions is compiled with -DTCL_8_API, this function will return +If your extensions is compiled with \fB-DTCL_8_API\fR, this function will return NULL for byte arrays larger than INT_MAX (which should trigger proper error-handling), otherwise expect it to crash. .BE diff --git a/doc/CrtAlias.3 b/doc/CrtAlias.3 index ba2e415..2ddf59e 100644 --- a/doc/CrtAlias.3 +++ b/doc/CrtAlias.3 @@ -87,7 +87,7 @@ for an alias. Pointer to location to store count of additional value arguments to be passed to the alias. The location is in storage owned by the caller. If it points to a variable which type is not \fBTcl_Size\fR, a compiler -warning will be generated. If your extensions is compiled with -DTCL_8_API, +warning will be generated. If your extensions is compiled with \fB-DTCL_8_API\fR, this function will return TCL_ERROR for aliases with more than INT_MAX value arguments, otherwise expect it to crash .AP Tcl_Obj ***objvPtr out diff --git a/doc/DictObj.3 b/doc/DictObj.3 index ec36d6a..0cc2e39 100644 --- a/doc/DictObj.3 +++ b/doc/DictObj.3 @@ -74,7 +74,7 @@ Points to a variable that will have the number of key/value pairs contained within the dictionary placed within it. May be (Tcl_Size *)NULL when not used. If it points to a variable which type is not \fBTcl_Size\fR, a compiler warning will be generated. -If your extensions is compiled with -DTCL_8_API, this function will return +If your extensions is compiled with \fB-DTCL_8_API\fR, this function will return NULL for dictionaries larger than INT_MAX (which should trigger proper error-handling), otherwise expect it to crash. .AP Tcl_DictSearch *searchPtr in/out diff --git a/doc/FileSystem.3 b/doc/FileSystem.3 index 86f96e6..5a50f53 100644 --- a/doc/FileSystem.3 +++ b/doc/FileSystem.3 @@ -278,7 +278,7 @@ permissions will be set on the created file. Filled with the number of elements in the split path. May be (Tcl_Size *)NULL when not used. If it points to a variable which type is not \fBTcl_Size\fR, a compiler warning will be generated. -If your extensions is compiled with -DTCL_8_API, this function will return +If your extensions is compiled with \fB-DTCL_8_API\fR, this function will return NULL for paths having more than INT_MAX elements (which should trigger proper error-handling), otherwise expect it to crash. .AP Tcl_Obj *basePtr in diff --git a/doc/ListObj.3 b/doc/ListObj.3 index 6e4d0d5..872b90f 100644 --- a/doc/ListObj.3 +++ b/doc/ListObj.3 @@ -65,7 +65,7 @@ Points to location where \fBTcl_ListObjGetElements\fR stores the number of element values in \fIlistPtr\fR. May be (Tcl_Size *)NULL when not used. If it points to a variable which type is not \fBTcl_Size\fR, a compiler warning will be generated. -If your extensions is compiled with -DTCL_8_API, this function will return +If your extensions is compiled with \fB\fB-DTCL_8_API\fR\fR, this function will return NULL for lists with more than INT_MAX elements (which should trigger proper error-handling), otherwise expect it to crash. .AP Tcl_Obj ***objvPtr out @@ -87,7 +87,7 @@ Points to location where \fBTcl_ListObjLength\fR stores the length of the list. May be (Tcl_Size *)NULL when not used. If it points to a variable which type is not \fBTcl_Size\fR, a compiler warning will be generated. -If your extensions is compiled with -DTCL_8_API, this function will return +If your extensions is compiled with \fB-DTCL_8_API\fR, this function will return TCL_ERROR for lists with more than INT_MAX elements (which should trigger proper error-handling), otherwise expect it to crash. .AP Tcl_Size index in diff --git a/doc/ParseArgs.3 b/doc/ParseArgs.3 index 594f4f1..ce61808 100644 --- a/doc/ParseArgs.3 +++ b/doc/ParseArgs.3 @@ -28,7 +28,7 @@ modified to hold number of arguments left in the unprocessed argument list stored in \fIremObjv\fR. May be (Tcl_Size *)NULL when not used. If it points to a variable which type is not \fBTcl_Size\fR, a compiler warning will be generated. -If your extensions is compiled with -DTCL_8_API, this function will return +If your extensions is compiled with \fB-DTCL_8_API\fR, this function will return NULL for argument lists with more than INT_MAX elements (which should trigger proper error-handling), otherwise expect it to crash. .AP "Tcl_Obj *const" *objv in diff --git a/doc/SplitList.3 b/doc/SplitList.3 index d036ace..cc47f03 100644 --- a/doc/SplitList.3 +++ b/doc/SplitList.3 @@ -43,7 +43,7 @@ Pointer to a string with proper list structure. Filled in with number of elements in \fIlist\fR. May be (Tcl_Size *)NULL when not used. If it points to a variable which type is not \fBTcl_Size\fR, a compiler warning will be generated. -If your extensions is compiled with -DTCL_8_API, this function will return +If your extensions is compiled with \fB-DTCL_8_API\fR, this function will return TCL_ERROR for lists with more than INT_MAX elements (which should trigger proper error-handling), otherwise expect it to crash. .AP "const char" ***argvPtr out diff --git a/doc/SplitPath.3 b/doc/SplitPath.3 index 452baff..25e672d 100644 --- a/doc/SplitPath.3 +++ b/doc/SplitPath.3 @@ -30,7 +30,7 @@ File path in a form appropriate for the current platform (see the Filled in with number of path elements in \fIpath\fR. May be (Tcl_Size *)NULL when not used. If it points to a variable which type is not \fBTcl_Size\fR, a compiler warning will be generated. -If your extensions is compiled with -DTCL_8_API, argcPtr will be filled +If your extensions is compiled with \fB-DTCL_8_API\fR, argcPtr will be filled with -1 for paths with more than INT_MAX elements (which should trigger proper error-handling), otherwise expect it to crash. .AP "const char" ***argvPtr out diff --git a/doc/StringObj.3 b/doc/StringObj.3 index f72c6a0..f13924a 100644 --- a/doc/StringObj.3 +++ b/doc/StringObj.3 @@ -124,7 +124,7 @@ The location where \fBTcl_GetStringFromObj\fR will store the length of a value's string representation. May be (Tcl_Size *)NULL when not used. If it points to a variable which type is not \fBTcl_Size\fR, a compiler warning will be generated. -If your extensions is compiled with -DTCL_8_API, this function will +If your extensions is compiled with \fB-DTCL_8_API\fR, this function will panic for strings with more than INT_MAX bytes/characters, otherwise expect it to crash. .AP "const char" *string in diff --git a/doc/Tcl_Main.3 b/doc/Tcl_Main.3 index 6410450..0258294 100644 --- a/doc/Tcl_Main.3 +++ b/doc/Tcl_Main.3 @@ -34,7 +34,7 @@ Tcl_Obj * Number of elements in \fIargv\fR. .AP char *argv[] in Array of strings containing command-line arguments. On Windows, when -using -DUNICODE, the parameter type changes to wchar_t *. +using \fB\-DUNICODE\fR, the parameter type changes to wchar_t *. .AP char *charargv[] in As argv, but does not change type to wchar_t. .AP char *wideargv[] in -- cgit v0.12