Re: svn commit: r360078 - in head: sbin/bectl share/man/man8

2020-04-19 Thread Conrad Meyer
There is also mdoc(7), which describes the same thing:

   SEE ALSO
   References other manuals with related topics.  This section should
   exist for most manuals.  Cross-references should conventionally be
   ordered first by section, then alphabetically (ignoring case).

I consult mdoc(7) frequently when writing or editing manual pages.

In addition to 'mandoc -Tlint', there is a tool in ports called 'igor'
which can be used to perform some style checking of manual pages.
Hope that helps!

Regards,
Conrad

On Sun, Apr 19, 2020 at 3:36 AM Mateusz Piotrowski <0...@freebsd.org> wrote:
>
> On 4/18/20 11:11 PM, Yuri Pankov wrote:
> > We don't have the man style guide (that I know of, at least)
> We have style.mdoc(5)!
___
svn-src-all@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscr...@freebsd.org"


Re: svn commit: r360078 - in head: sbin/bectl share/man/man8

2020-04-19 Thread Yuri Pankov

Mateusz Piotrowski wrote:

On 4/18/20 11:11 PM, Yuri Pankov wrote:

We don't have the man style guide (that I know of, at least)

We have style.mdoc(5)!


Now I know, thanks.

May be it would make sense to reference it from style(9) as it's where I 
was looking, and SEE ALSO already lists style.Makefile and style.lua?

___
svn-src-all@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscr...@freebsd.org"


Re: svn commit: r360078 - in head: sbin/bectl share/man/man8

2020-04-19 Thread Mateusz Piotrowski

On 4/18/20 11:11 PM, Yuri Pankov wrote:

We don't have the man style guide (that I know of, at least)

We have style.mdoc(5)!
___
svn-src-all@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscr...@freebsd.org"


Re: svn commit: r360078 - in head: sbin/bectl share/man/man8

2020-04-18 Thread Yuri Pankov

Alan Somers wrote:

Author: asomers
Date: Sat Apr 18 19:53:47 2020
New Revision: 360078
URL: https://svnweb.freebsd.org/changeset/base/360078

Log:
   bectl.8, beinstall.sh.8: fix man page section of beinstall.sh
   
   Reported by:	phk

   MFC after:   2 weeks

Modified:
   head/sbin/bectl/bectl.8
   head/share/man/man8/beinstall.8

Modified: head/sbin/bectl/bectl.8
==
--- head/sbin/bectl/bectl.8 Sat Apr 18 19:47:38 2020(r360077)
+++ head/sbin/bectl/bectl.8 Sat Apr 18 19:53:47 2020(r360078)
@@ -17,7 +17,7 @@
  .\"
  .\" $FreeBSD$
  .\"
-.Dd September 11, 2019
+.Dd April 18, 2020
  .Dt BECTL 8
  .Os
  .Sh NAME
@@ -343,7 +343,7 @@ is specified.
  To fill in with jail upgrade example when behavior is firm.
  .El
  .Sh SEE ALSO
-.Xr beinstall.sh 1 ,
+.Xr beinstall.sh 8 ,
  .Xr libbe 3 ,
  .Xr jail 8 ,
  .Xr zfs 8 ,


This breaks the sorting used in SEE ALSO:

$ mandoc -Tlint -Wwarning sbin/bectl/bectl.8
mandoc: sbin/bectl/bectl.8:347:2: WARNING: unusual Xr order: libbe(3) 
after beinstall.sh(8)


We don't have the man style guide (that I know of, at least), but 
keeping it consistent would be nice.



Modified: head/share/man/man8/beinstall.8
==
--- head/share/man/man8/beinstall.8 Sat Apr 18 19:47:38 2020
(r360077)
+++ head/share/man/man8/beinstall.8 Sat Apr 18 19:53:47 2020
(r360078)
@@ -25,8 +25,8 @@
  .\" SUCH DAMAGE.
  .\"
  .\" $FreeBSD$
-.Dd August 20, 2018
-.Dt BEINSTALL.SH 1
+.Dd April 18, 2020
+.Dt BEINSTALL.SH 8
  .Os
  .Sh NAME
  .Nm beinstall.sh

___
svn-src-all@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscr...@freebsd.org"


svn commit: r360078 - in head: sbin/bectl share/man/man8

2020-04-18 Thread Alan Somers
Author: asomers
Date: Sat Apr 18 19:53:47 2020
New Revision: 360078
URL: https://svnweb.freebsd.org/changeset/base/360078

Log:
  bectl.8, beinstall.sh.8: fix man page section of beinstall.sh
  
  Reported by:  phk
  MFC after:2 weeks

Modified:
  head/sbin/bectl/bectl.8
  head/share/man/man8/beinstall.8

Modified: head/sbin/bectl/bectl.8
==
--- head/sbin/bectl/bectl.8 Sat Apr 18 19:47:38 2020(r360077)
+++ head/sbin/bectl/bectl.8 Sat Apr 18 19:53:47 2020(r360078)
@@ -17,7 +17,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd September 11, 2019
+.Dd April 18, 2020
 .Dt BECTL 8
 .Os
 .Sh NAME
@@ -343,7 +343,7 @@ is specified.
 To fill in with jail upgrade example when behavior is firm.
 .El
 .Sh SEE ALSO
-.Xr beinstall.sh 1 ,
+.Xr beinstall.sh 8 ,
 .Xr libbe 3 ,
 .Xr jail 8 ,
 .Xr zfs 8 ,

Modified: head/share/man/man8/beinstall.8
==
--- head/share/man/man8/beinstall.8 Sat Apr 18 19:47:38 2020
(r360077)
+++ head/share/man/man8/beinstall.8 Sat Apr 18 19:53:47 2020
(r360078)
@@ -25,8 +25,8 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD$
-.Dd August 20, 2018
-.Dt BEINSTALL.SH 1
+.Dd April 18, 2020
+.Dt BEINSTALL.SH 8
 .Os
 .Sh NAME
 .Nm beinstall.sh
___
svn-src-all@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscr...@freebsd.org"