[Bug 269359] hv_hid needs a manpage

From: <bugzilla-noreply_at_freebsd.org>
Date: Fri, 16 May 2025 17:06:06 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=269359

Andrew Reiter <arr@watson.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |arr@watson.org

--- Comment #2 from Andrew Reiter <arr@watson.org> ---
(In reply to Yuri from comment #1)
I hesitate send this response and attachment as it is openai o4 generated
patch, but I thought perhaps it could bootstrap handling the request for the
man page. And perhaps an experiment in using that system to help solve FreeBSD
issues. My apologies if this is an unwanted response ... and I'll not do such a
pattern in the future, if that is the case.


```
--- /dev/null
+++ b/share/man/man4/hv_hid.4
@@
+.\" Copyright (c) 2025 The FreeBSD Project
+.\" All rights reserved.
+.\" 
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS "AS IS" AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\" 
+.\" $FreeBSD$
+.\" 
+.Dd May 16, 2025
+.Dt HV_HID 4
+.Os
+.Sh NAME
+.Nm hv_hid
+.Nd Hyper-V HID transport driver
+.Sh SYNOPSIS
+To compile this driver into the kernel, place the following line in your
+kernel configuration file:
+.Bd -literal -offset indent
+device hv_hid
+.Ed
+.
+Alternatively, to load the driver as a module at boot time, add the following
+line to
+.Pa /boot/loader.conf :
+.Bd -literal -offset indent
+hv_hid_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the HID (Human Interface Device) input channel
+exposed by the Hyper-V virtual machine bus (VMBus). It acts as a transport
+between the Hyper-V host and the
+.Xr hms 4
+mouse subsystem in FreeBSD guests.
+.
+This driver is automatically loaded when running under Hyper-V and does not
+require manual configuration. It has no tunable parameters.
+.Sh SEE ALSO
+.Xr hms 4
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Fx 14.0 .
+.Sh AUTHORS
+.An Microsoft Corporation ,
+.An FreeBSD Hyper-V team
+.An -and others
```

-- 
You are receiving this mail because:
You are on the CC list for the bug.