git: 9e337d53dee6 - main - tslog.4: Document what TSLOG excels at

From: Mateusz Piotrowski <0mp_at_FreeBSD.org>
Date: Fri, 01 Jul 2022 09:18:32 UTC
The branch main has been updated by 0mp (doc, ports committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=9e337d53dee685327961b8a070d477ef97b85b86

commit 9e337d53dee685327961b8a070d477ef97b85b86
Author:     Mateusz Piotrowski <0mp@FreeBSD.org>
AuthorDate: 2022-07-01 09:17:12 +0000
Commit:     Mateusz Piotrowski <0mp@FreeBSD.org>
CommitDate: 2022-07-01 09:17:12 +0000

    tslog.4: Document what TSLOG excels at
    
    Based on an email mhorne@ sent to arch@.
    
    Reviewed by:    debdrup, pauamma_gundo.com
    MFC after:      1 week
    Differential Revision:  https://reviews.freebsd.org/D34565
---
 share/man/man4/tslog.4 | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/share/man/man4/tslog.4 b/share/man/man4/tslog.4
index e3ee8bca0fee..5b0f5fbb1264 100644
--- a/share/man/man4/tslog.4
+++ b/share/man/man4/tslog.4
@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd March 4, 2022
+.Dd June 1, 2022
 .Dt TSLOG 4
 .Os
 .Sh NAME
@@ -38,7 +38,9 @@ place the following line in the kernel configuration file:
 .Sh DESCRIPTION
 .Nm
 is a boot-time event tracing facility.
-Its purpose is to ease diagnosing and reducing the overall
+It is suitable for tracing recursive events
+based on function entries and exits.
+Its purpose is to ease pinpointing and reducing the overall
 .Fx
 boot time by generating detailed timing information.
 .Pp