Re: Question relationship of builting(1) and functions refrenced through .Xr
Hi Alexander, That does give some clarity and do appreciate it. It looks like info(1) needs to go as a link.. I will submit a pull request. But this brings me to a larger question/possible issue: Is there a way to coordinate manual page updates? I see a lot of effort and guidance on the documentation portion but not manual pages. Kind Regards, Chris From: owner-freebsd-...@freebsd.org on behalf of Alexander Ziaee Date: Friday, March 8, 2024 at 3:29 PM To: freebsd-doc Subject: Re: Question relationship of builting(1) and functions refrenced through .Xr Hi, (Chris Davidson asked) > How does the manual page relationship work > between the builtin(1) manual pages and the > individual .Xr links to other pages Builtin(1) describes shell builtin commands, but the links in this see also section refer to: - pages for valid, discrete programs in the base system with identical names to these builtin commands - the shells supplying the builtin commands - the link that you are looking for, info(1), which we had until FreeBSD 11 [0] and can probably be removed For example, I have a shell builtin 'which' and I also have a '/usr/bin/which'. I investigate suspicious links with that command and whereis(1), but I feel like I need to at least glance over the pages or it gets too meta. [0] https://man-dev.freebsd.org/FreeBSD-10.0-RELEASE/info.1 Hope this helps! Alexander Ziaee
Re: Question relationship of builting(1) and functions refrenced through .Xr
Hi, (Chris Davidson asked) > How does the manual page relationship work > between the builtin(1) manual pages and the > individual .Xr links to other pages Builtin(1) describes shell builtin commands, but the links in this see also section refer to: - pages for valid, discrete programs in the base system with identical names to these builtin commands - the shells supplying the builtin commands - the link that you are looking for, info(1), which we had until FreeBSD 11 [0] and can probably be removed For example, I have a shell builtin 'which' and I also have a '/usr/bin/which'. I investigate suspicious links with that command and whereis(1), but I feel like I need to at least glance over the pages or it gets too meta. [0] https://man-dev.freebsd.org/FreeBSD-10.0-RELEASE/info.1 Hope this helps! Alexander Ziaee
Question relationship of builting(1) and functions refrenced through .Xr
Hi Documentation Team, I am investigating some updates to manual pages and came across a “self referencing” warning from the mandoc -Tlint utility, on entries associated with the builtin(1) manual page. Some examples of this self referencing are: done(1), false(1), etc.. in particular entries on lines: 308, 309, 311,312,313,314,315,316,317,319,321,322. These lines are associated with the SEE ALSO section which convention states we should use .Xr entries which causes the self-referencing warning. Question to the group is: How does the manual page relationship work between the builtin(1) manual pages and the individual .Xr links to other pages, such as done(1) false(1)? I have a little more detail on this here: https://bughuntingfreebsd.wordpress.com/2024/03/07/fixing-self-referencing/ I am currently at a lose to address this warning as using .Xr gives a warning and using the .Nm is not the best option. Thank you in advance for any guidance or suggestions you can provide. Kind Regards, Chris
