From 87be9a1567e0caa10d71ef866b8e2d8fa625c584 Mon Sep 17 00:00:00 2001 From: Mark Lumsden Date: Wed, 12 Jun 2019 06:01:27 +0000 Subject: A note about log.c. --- usr.bin/mg/log.c | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/usr.bin/mg/log.c b/usr.bin/mg/log.c index ed3c27ccb37..22072452f3e 100644 --- a/usr.bin/mg/log.c +++ b/usr.bin/mg/log.c @@ -1,4 +1,4 @@ -/* $OpenBSD: log.c,v 1.3 2019/06/10 18:55:15 lum Exp $ */ +/* $OpenBSD: log.c,v 1.4 2019/06/12 06:01:26 lum Exp $ */ /* * This file is in the public domain. @@ -11,6 +11,16 @@ * Record a history of an mg session for temporal debugging. * Sometimes pressing a key will set the scene for a bug only visible * dozens of keystrokes later. gdb has its limitations in this scenario. + * + * Note this file is not compiled into mg by default, you will need to + * amend the 'Makefile' for that to happen. Because of this, the code + * is subjet to bit-rot. However, I know myself and others have + * written similar functionally often enough, that recording the below + * in a code repository could aid the developement efforts of mg, even + * if it requires a bit of effort to get working. The current code is + * written in the spirit of debugging (quickly and perhaps not ideal, + * but it does what is required well enough). Should debugging become + * more formalised within mg, then I would expect that to change. */ #include -- cgit v1.2.3