mandoc -Tlint systat.1 fix

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

mandoc -Tlint systat.1 fix

David Gwynne-5
lint thinks uvm_swap_get() looks like a function name, so this uses .Fn
to mark it up as one.

ok?

Index: systat.1
===================================================================
RCS file: /cvs/src/usr.bin/systat/systat.1,v
retrieving revision 1.110
diff -u -p -r1.110 systat.1
--- systat.1 25 Jul 2018 17:24:14 -0000 1.110
+++ systat.1 4 Mar 2019 10:58:15 -0000
@@ -697,7 +697,8 @@ swap pages in use
 .It swpgonly
 in use swap pages not in RAM
 .It nswget
-fault called uvm_swap_get()
+fault called
+.Fn uvm_swap_get
 .It nanon
 total anon's
 .Pp

Reply | Threaded
Open this post in threaded view
|

Re: mandoc -Tlint systat.1 fix

Ingo Schwarze
Hi David,

David Gwynne wrote on Mon, Mar 04, 2019 at 08:59:12PM +1000:

> lint thinks uvm_swap_get() looks like a function name,
> so this uses .Fn to mark it up as one.
>
> ok?

Sure.

Given that the function uvm_swap_get() appears to be important enough
to be mentioned even in a userland manual page, would it maybe also
make sense to document it in uvm(9)?  Not sure, just asking.

If so, then the line would become ".Xr uvm_swap_get 9" afterwards.

Yours,
  Ingo


> Index: systat.1
> ===================================================================
> RCS file: /cvs/src/usr.bin/systat/systat.1,v
> retrieving revision 1.110
> diff -u -p -r1.110 systat.1
> --- systat.1 25 Jul 2018 17:24:14 -0000 1.110
> +++ systat.1 4 Mar 2019 10:58:15 -0000
> @@ -697,7 +697,8 @@ swap pages in use
>  .It swpgonly
>  in use swap pages not in RAM
>  .It nswget
> -fault called uvm_swap_get()
> +fault called
> +.Fn uvm_swap_get
>  .It nanon
>  total anon's
>  .Pp