[Bug 284596] Confused about header file reference in tty(4) man page.

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=284596

            Bug ID: 284596
           Summary: Confused about header file reference in tty(4) man
                    page.
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Manual Pages
          Assignee: bugs@FreeBSD.org
          Reporter: artembunichev@zohomail.com
                CC: doc@FreeBSD.org

I was reading tty(4) manual page, in particular the description for TIOCGWINSZ
request. In the end of it it says "The winsize structure is defined in
<sys/ioctl.h>.". I never worked with winsize structure, so I didn't know what's
in it and decided to have a look. I did a quick search for "winsize" in
/usr/include/sys/ioctl.h, but it didn't give any result. I figured that struct
winsize is actually defined in /usr/include/sys/_winsize.h and then it's
included in ioctl.h like that: _winsize.h -> ttycom.h -> ioctl.h.

So it's true that winsize is defined in ioctl.h, but it's actually not that
helpful if you want to look at the structure itself. Honestly, I'm not sure:
maybe it's normal for manual pages to refer structures in such way; I don't
have much knowledge about header files internals and the way they should be
named in the manual pages, maybe their locations are machine-dependent.
However, I'm thinking maybe it would be good to mention the <sys/_winsize.h> in
the page too, so that it will be clear for one who wants to look at the
structure where to go.

-- 
You are receiving this mail because:
You are the assignee for the bug.