Skip to content

Commit 80ace15

Browse files
synesissoftwaresynesissoftware
committed
Release WriteDebugString 0.0.2
Update version metadata and documentation, install the new section-1 man page, and align executable naming with the CMake target.
1 parent 629dab0 commit 80ace15

8 files changed

Lines changed: 61 additions & 8 deletions

File tree

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
/_internal/
99

1010
/bin/
11-
/doc/
1211
/include/
1312
/lib/
1413
/node_modules/

‎CHANGES.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# **WriteDebugString** Changes <!-- omit in toc -->
1+
# WriteDebugString - Changes <!-- omit in toc -->
2+
3+
4+
## 0.0.2 - 24th August 2026
5+
6+
* Updated the CMake configuration to honour caller-supplied C and C++ standards and report the build type;
7+
* Normalised the CMake executable target name to **writedebugstring**;
8+
* Improved CMake helper scripts with safer path handling, project identity, coloured status diagnostics, and configurable C standards;
9+
* Expanded repository metadata and Visual Studio Code C/C++ configuration;
10+
* Expanded GitHub Actions push-branch coverage;
11+
* Updated the executable version to 0.0.2;
12+
* Added a section-1 reference page and installed it with CMake;
213

314

415
## 0.0.1 - 3rd August 2026

‎CMakeLists.txt‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Purpose: Top-level CMake lists file for WriteDebugString
55
#
66
# Created: 3rd August 2026
7-
# Updated: 3rd August 2026
7+
# Updated: 24th August 2026
88
#
99
# ######################################################################## #
1010

@@ -213,6 +213,11 @@ install(TARGETS ${PROJECT_NAME_LOWER}
213213
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
214214
)
215215

216+
install(FILES
217+
doc/${PROJECT_NAME_LOWER}.1
218+
DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
219+
)
220+
216221

217222
# ################################################
218223
# examples

‎INSTALL.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ The primary choice for installation is by use of **CMake**.
6868

6969
```bash
7070
$ cd ~/open-source/WriteDebugString
71-
$ ./_build/WriteDebugString.exe --help
71+
$ ./_build/writedebugstring.exe --help
7272
```
7373

74-
You should see usage output naming **WriteDebugString**.
74+
You should see usage output naming **writedebugstring**.
7575

7676
5. Install (optional), as in:
7777

‎NEWS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
| Date | News Item |
55
| -------------------- | -------------------------------------------------- |
6+
| 24th August 2026 | [0.0.2 released](https://github.com/sistools/WriteDebugString/releases/tag/0.0.2) |
67
| 3rd August 2026 | 0.0.1 released |
78

89

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ The project creates a single executable program, **WriteDebugString**.
4646
## Examples
4747

4848
```plaintext
49-
> WriteDebugString.exe hello world
49+
> writedebugstring.exe hello world
5050
wrote 2 message(s) to debug stream
5151
52-
> WriteDebugString.exe --sleep-after-writes "hold for listener"
52+
> writedebugstring.exe --sleep-after-writes "hold for listener"
5353
wrote 1 message(s) to debug stream
5454
```
5555

‎doc/writedebugstring.1‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.\" Copyright (c) 2020-2026, Matthew Wilson and Synesis Information Systems
2+
.\"
3+
.TH WRITEDEBUGSTRING 1 "August 2026" "writedebugstring 0.0.2" "User Commands"
4+
.SH NAME
5+
writedebugstring \- write messages to the Windows debug output stream
6+
.SH SYNOPSIS
7+
.B writedebugstring
8+
[\fIOPTION\fR]
9+
[\fIMESSAGE\fR ...]
10+
.SH DESCRIPTION
11+
.B writedebugstring
12+
writes each
13+
.I MESSAGE
14+
to the Windows debug output stream using
15+
.BR OutputDebugString .
16+
Messages can be observed by an attached debugger or a tool such as DebugView.
17+
After successful writes, the program reports the number of messages written
18+
on standard output.
19+
.PP
20+
This is a Windows-only command.
21+
.SH OPTIONS
22+
.TP
23+
.B \-\-help
24+
Display usage information and exit.
25+
.TP
26+
.B \-\-sleep-after-writes
27+
Wait five seconds after writing the messages.
28+
.TP
29+
.B \-\-version
30+
Display version information and exit.
31+
.SH REPORTING BUGS
32+
Report defects and feature requests at
33+
https://github.com/sistools/WriteDebugString.
34+
.SH AUTHOR
35+
Matthew Wilson and Synesis Information Systems
36+
.br
37+
Copyright (c) 2020\-2026, Matthew Wilson and Synesis Information Systems

‎main.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
#define WRITEDEBUGSTRING_VER_MAJOR 0
1919
#define WRITEDEBUGSTRING_VER_MINOR 0
20-
#define WRITEDEBUGSTRING_VER_PATCH 1
20+
#define WRITEDEBUGSTRING_VER_PATCH 2
2121

2222

2323
int main(int argc, char* argv[])

0 commit comments

Comments
 (0)