9front - general discussion about 9front
 help / color / mirror / Atom feed
* [9front] Re: man pages
       [not found] <CABB-WO9mMVTigW9s96s88nPvA8fEijD6m-K_aR-=cMvDG363dQ@mail.gmail.com>
@ 2021-08-14 16:56 ` Stuart Morrow
  2021-08-24 17:21   ` Stuart Morrow
  0 siblings, 1 reply; 18+ messages in thread
From: Stuart Morrow @ 2021-08-14 16:56 UTC (permalink / raw)
  To: 9front

'UTF' appears in small caps throughout the manual, so this makes
uthml(1) consistent. It's relative to the uhtml earlier in this
thread.

diffy /sys/man/1/uhtml
24c24,26
< to convert it to UTF replacing HTML-entity forms
---
> to convert it to
> .SM UTF
> replacing HTML-entity forms

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [9front] Re: man pages
  2021-08-14 16:56 ` [9front] Re: man pages Stuart Morrow
@ 2021-08-24 17:21   ` Stuart Morrow
  2021-08-24 20:27     ` qwx
  0 siblings, 1 reply; 18+ messages in thread
From: Stuart Morrow @ 2021-08-24 17:21 UTC (permalink / raw)
  To: 9front

Once again I am asking for your support

On 14/08/2021, Stuart Morrow <morrow.stuart@gmail.com> wrote:
> 'UTF' appears in small caps throughout the manual, so this makes
> uhtml(1) consistent. It's relative to the uhtml earlier in this
> thread.
>
> diffy /sys/man/1/uhtml
> 24c24,26
> < to convert it to UTF replacing HTML-entity forms
> ---
>> to convert it to
>> .SM UTF
>> replacing HTML-entity forms
>

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 17:21   ` Stuart Morrow
@ 2021-08-24 20:27     ` qwx
  2021-08-24 21:02       ` Stuart Morrow
  2021-08-24 21:20       ` Humm
  0 siblings, 2 replies; 18+ messages in thread
From: qwx @ 2021-08-24 20:27 UTC (permalink / raw)
  To: 9front

> Once again I am asking for your support
> 
> On 14/08/2021, Stuart Morrow <morrow.stuart@gmail.com> wrote:
> > 'UTF' appears in small caps throughout the manual, so this makes
> > uhtml(1) consistent. It's relative to the uhtml earlier in this
> > thread.
> >
> > diffy /sys/man/1/uhtml
> > 24c24,26
> > < to convert it to UTF replacing HTML-entity forms
> > ---
> >> to convert it to
> >> .SM UTF
> >> replacing HTML-entity forms
> >

Hi,

I think this is ok, but I see plenty of other instances of this,
just run `grep -i utf /sys/man/*/*'.  I'd fix them as well all
at once.  I'm sure there are all of sorts of inconsistencies all
over the place, but expecting anyone to review and fix everything
at once is too much, it won't happen.  If you see any others
right now, it would be nice to fix them too, in my opinion.

Cheers,

qwx

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 20:27     ` qwx
@ 2021-08-24 21:02       ` Stuart Morrow
  2021-08-24 21:09         ` hiro
                           ` (2 more replies)
  2021-08-24 21:20       ` Humm
  1 sibling, 3 replies; 18+ messages in thread
From: Stuart Morrow @ 2021-08-24 21:02 UTC (permalink / raw)
  To: 9front

I was referring to the first post in the thread, with the 12K attachment.

Those diffs were at that time already a month old and ignored.

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 21:02       ` Stuart Morrow
@ 2021-08-24 21:09         ` hiro
  2021-08-24 21:13           ` Stuart Morrow
  2021-08-24 21:33           ` Stuart Morrow
  2021-08-24 21:34         ` ori
  2021-08-24 21:49         ` qwx
  2 siblings, 2 replies; 18+ messages in thread
From: hiro @ 2021-08-24 21:09 UTC (permalink / raw)
  To: 9front

i don't think i ever received your first post in the thread

On 8/24/21, Stuart Morrow <morrow.stuart@gmail.com> wrote:
> I was referring to the first post in the thread, with the 12K attachment.
>
> Those diffs were at that time already a month old and ignored.
>

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 21:09         ` hiro
@ 2021-08-24 21:13           ` Stuart Morrow
  2021-08-24 21:33           ` Stuart Morrow
  1 sibling, 0 replies; 18+ messages in thread
From: Stuart Morrow @ 2021-08-24 21:13 UTC (permalink / raw)
  To: 9front

[-- Attachment #1: Type: text/plain, Size: 1 bytes --]



[-- Attachment #2: diff --]
[-- Type: application/octet-stream, Size: 11970 bytes --]

--- //.git/fs/object/c6a9c55de7e5d1d510a717cffd42648d249269db/tree/sys/man/1/uhtml
+++ sys/man/1/uhtml
@@ -1,6 +1,6 @@
 .TH UHTML 1
 .SH NAME
-uhtml \- convert foreign character set HTML file to unicode
+uhtml \- convert foreign-character-set HTML file to Unicode
 .SH SYNOPSIS
 .B uhtml
 [
@@ -12,24 +12,24 @@
 .I file
 ]
 .SH DESCRIPTION
-HTML comes in various character set encodings
+HTML comes in various character-set encodings
 and has special forms to encode characters. To
-make it easier to process html, uhtml is used
-to normalize it to a unicode only form.
+make it easier to process HTML, uhtml is used
+to normalize it to a Unicode-only form.
 .LP
-Uhtml detects the character set of the html input
+Uhtml detects the character set of the HTML input
 .I file
 and calls
 .IR tcs (1)
-to convert it to utf replacing html-entity forms
-by ther unicode character representations except for 
-.B lt
-.B gt
-.B amp
-.B quot
+to convert it to UTF replacing HTML-entity forms
+by their Unicode character representations except for 
+.BR lt ,
+.BR gt ,
+.BR amp ,
+.BR quot ,
 and
-.B apos .
-The converted html is written to
+.BR apos .
+The converted HTML is written to
 standard output. If no
 .I file
 was given, it is read from standard input. If the
@@ -36,7 +36,8 @@
 .B -p
 option is given, the detected character set is printed and
 the program exits without conversion.
-In case character set detection fails, the default (utf)
+In case character-set detection fails, the default
+.RB ( utf )
 is assumed. This default can be changed with the
 .B -c
 option.
--- //.git/fs/object/c6a9c55de7e5d1d510a717cffd42648d249269db/tree/sys/man/4/nusb
+++ sys/man/4/nusb
@@ -88,7 +88,7 @@
 .B usbevent
 (usually seen as
 .BR /dev/usbevent )
-which, when read, returns a 6 column, space separated line of
+which, when read, returns a 6-column, space-separated line of
 text, one for each event. The columns are:
 .B attach
 or
@@ -99,7 +99,7 @@
 .I did
 .I csp
 and
-.I hname .
+.IR hname .
 The
 .I addr
 is the decimal device address assigned.
@@ -111,9 +111,9 @@
 is the device class, subclass, protocol indentifier
 formatted as 6 digit hexadecimal.
 .I Usbd
-assigns a stable device unique name based on the
+assigns a stable device identifier based on the
 device descriptor for
-.I hname .
+.IR hname .
 This information is read by
 .IR nusbrc (8)
 and the
@@ -142,7 +142,7 @@
 .BR /dev )
 that includes one directory per storage device, named
 .BI sdU N [. M ]
-in correspondence with the usb device unique name
+in correspondence with the USB device identifier
 and the storage unit number (or LUN). The LUN is omited
 for single lun devices.
 .PP
@@ -160,7 +160,7 @@
 .SS Ethernet
 .I Ether
 handles USB ethernet devices. The file system provided is
-compatible to
+compatible with
 .IR ether (3)
 and added to the share
 .B usbnet
@@ -232,9 +232,9 @@
 .SS Audio devices
 .I Audio
 configures and manages a USB audio device.
-It implements a file system, (normally seen under
-.BI /dev )
-compatible to
+It implements a file system (normally seen under
+.BR /dev ),
+compatible with
 .IR audio (3).
 .SH SOURCE
 .B /sys/src/cmd/nusb
--- //.git/fs/object/c6a9c55de7e5d1d510a717cffd42648d249269db/tree/sys/man/4/rio
+++ sys/man/4/rio
@@ -225,7 +225,7 @@
 .B wctl
 accepts messages to change the size or placement of the associated window,
 and to create new windows.
-The messages are in a command-line like format, with a command name,
+The messages are in a command-line-like format, with a command name,
 possibly followed by options introduced by a minus sign.
 The options must be separated by blanks, for example
 .B -dx 100
@@ -276,14 +276,14 @@
 .B new
 commands accept
 .B -minx
-.IR n ,
+.RI [±] n ,
 .B -miny
-.IR n ,
+.RI [±] n ,
 .B -maxx
-.IR n ,
+.RI [±] n ,
 and
-.BR -maxy
-.I n
+.B -maxy
+.RI [±] n
 options to set the position of the corresponding edge of the window.
 They also accept an option
 .B -r
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/1/vac
+++ /sys/man/1/vac
@@ -82,7 +82,7 @@
 .I yyyy/mmdd
 (year, month, day)
 in the style of the dump file system
-(see Plan 9's \fIfs\fR(4)).
+(see \fIfs\fR(4)).
 If
 .I vacfile
 already exists, an additional backup day is added to the
@@ -184,7 +184,7 @@
 .I pattern
 or
 .B exclude
-.I pattern .
+.IR pattern .
 When considering whether to include a directory or file
 in the vac archive,
 the earliest matching pattern in the file
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/2/9p
+++ /sys/man/2/9p
@@ -511,7 +511,7 @@
 will handle the request given pointers to two functions
 .I walk1
 and (optionally)
-.I clone .
+.IR clone .
 .IR Clone ,
 if non-nil, is called to signal the creation of
 .I newfid
@@ -881,7 +881,7 @@
 .IR nntpfs (4),
 .IR snap (4),
 and
-.B /sys/src/lib9p/ramfs.c
+.B /sys/src/cmd/ramfs.c
 are good examples of simple single-threaded file servers.
 .PP
 In general, the
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/2/ioproc
+++ /sys/man/2/ioproc
@@ -92,7 +92,7 @@
 .PP
 .I Closeioproc
 terminates the I/O proc and frees the associated
-.B Ioproc .
+.BR Ioproc .
 .PP
 .I Iocall
 is a primitive that may be used to implement
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/2/ip
+++ /sys/man/2/ip
@@ -97,7 +97,7 @@
 .SH DESCRIPTION
 These routines are used by Internet Protocol (IP) programs to
 manipulate IP and Ethernet addresses.
-Plan 9, by default, uses V6 format IP addresses.  Since V4
+Plan 9, by default, uses V6-format IP addresses.  Since V4
 addresses fit into the V6 space, all IP addresses can be represented.
 IP addresses are stored as a string of 16
 .B unsigned
@@ -222,7 +222,7 @@
 .PP
 .I Defmask
 returns the standard class A, B, or C mask for
-.I ipaddr .
+.IR ipaddr .
 .PP
 .I Isv4
 returns non-zero if the V6 address is in the V4 space, that is,
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/4/cdfs
+++ /sys/man/4/cdfs
@@ -203,7 +203,7 @@
 option will print rc commands using
 .IR audio/flacenc (1)
 to encode and tag audio tracks from the disc to output directory
-.I dir .
+.IR dir .
 .SH EXAMPLES
 Backup to a BD-R disc:
 .br
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/6/authsrv
+++ /sys/man/6/authsrv
@@ -283,7 +283,7 @@
 proving to the client that it also knows
 .I Kn
 and therefore 
-.I Ks .
+.IR Ks .
 .PP
 The 64-bit shared secret
 .I Kn
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/8/ndb
+++ /sys/man/8/ndb
@@ -764,7 +764,7 @@
 .PP
 .I Ndb/dnsgetip
 resolves and prints A and AAAA records without consulting
-.I ndb/dns .
+.IR ndb/dns .
 By default,
 .I ndb/dnsgetip
 queries A records first and then AAAA records. As with
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/8/venti-backup
+++ /sys/man/8/venti-backup
@@ -66,7 +66,7 @@
 (default
 .BR 0 )
 in
-.I arenafile .
+.IR arenafile .
 This is useful for reading directly from
 the Venti arena partition:
 .IP
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree/sys/man/1/deroff
+++ sys/man/1/deroff
@@ -83,11 +83,11 @@
 .IR spell (1)
 .SH BUGS
 This filter is not a complete interpreter of
-.I troff .
+.IR troff .
 For example, macro definitions containing
 .L \e$
 cause chaos in
-.IR deroff
+.I deroff
 when the popular
 .L $$
 delimiters for
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree/sys/man/1/leak
+++ sys/man/1/leak
@@ -158,7 +158,7 @@
 .I Umem
 prints summarizes all allocations, not just 
 memory leaks, but it is faster and requires less memory than 
-.I leak .
+.IR leak .
 .PP
 .I Kmem
 is like
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree/sys/man/2/pushtls
+++ sys/man/2/pushtls
@@ -78,10 +78,10 @@
 descriptor will get encrypted and authenticated and then written to the
 file descriptor,
 .IR fd .
-.I Pushtls ,
-.IR tlsClient
+.IR Pushtls ,
+.I tlsClient
 and
-.IR tlsServer
+.I tlsServer
 close the original file descriptor on success.
 If
 .I dir
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree/sys/man/2/venti-cache
+++ sys/man/2/venti-cache
@@ -126,7 +126,7 @@
 with room for
 .I nblocks
 of maximum block size
-.I blocksize .
+.IR blocksize .
 .PP
 .I Vtcachefree
 frees a cache and all the associated blocks.
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree/sys/man/2/venti-log
+++ sys/man/2/venti-log
@@ -54,7 +54,7 @@
 .PP
 .I Vtlogopen
 returns a reference to the log with the given
-.I name .
+.IR name .
 If a log with that name does not exist and
 .I size 
 is non-zero,
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree/sys/man/3/cmd
+++ sys/man/3/cmd
@@ -61,7 +61,7 @@
 Run the host command in directory
 .IR wdir ,
 which is a directory
-.I "on the host system" .
+.IR "on the host system" .
 Issue this request before starting the command.
 By default, commands are run in the Inferno root directory on the host system.
 .TP
@@ -207,10 +207,10 @@
 .SS "Command execution"
 In all cases, the command runs in the host operating system's
 own file name space.
-All file names will be interpreted in that space, not Plan9's.
+All file names will be interpreted in that space, not Plan 9's.
 For example, on Unix
 .B /
-refers to the host's file system root, not Plan9's;
+refers to the host's file system root, not Plan 9's;
 the effects of mounts and binds will not be visible.
 .SH "SEE ALSO"
 .IR os (1)
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree/sys/man/3/usb
+++ sys/man/3/usb
@@ -19,7 +19,7 @@
 .SH DESCRIPTION
 The Universal Serial Bus is a complex yet popular bus
 for connecting all kind of devices to a computer.
-It is a four-wire tree-shaped bus that provides both communication and (limited)
+It is a tree-shaped bus that provides both communication and (limited)
 power to devices.
 Branching points in the tree are provided by devices called
 .IR hubs .
@@ -41,7 +41,6 @@
 EHCI for USB 2 (up to 480 Mb/s)
 and
 XHCI for USB 3 (up to 5 Gb/s).
-We currently support all but XHCI, which is still quite new.
 .PP
 The USB bus is fully controlled by the host; all devices are polled.
 Hubs are passive in the sense that they do not poll the devices attached
@@ -57,7 +56,7 @@
 Specialization continues as subclasses and subsubclasses are explored.
 .PP
 Enumeration of the bus and initial configuration of devices is done
-by a user level program,
+by a user-level program,
 .IR usbd .
 Device drivers are implemented by separate user programs, although
 some of them may be statically linked into
@@ -179,7 +178,7 @@
 to resume I/O.
 The most common error is
 .L crc/timeout
-indicating problems in communication with the device (eg., a physical
+indicating problems in communication with the device (e.g., a physical
 detach of the device or a wiring problem).
 .PP
 For control and isochronous transfers, there is an implicit
@@ -267,9 +266,11 @@
 (1.5 Mb/s),
 .BR full
 (12 Mb/s),
-or
 .BR high
-(480 Mb/s).
+(480 Mb/s)
+or
+.BR super
+(5 Gb/s).
 .TP
 Maximum packet size
 Used when performing I/O on the data file.
@@ -426,7 +427,7 @@
 .TP
 .BI name " str"
 Generates an additional file name,
-.I str ,
+.IR str ,
 for the
 .B data
 file of the endpoint.
@@ -484,16 +485,16 @@
 .BR rw ,
 which creates, respectively, an input, output, or input/output endpoint.
 .TP
-.B "speed {low|full|high}
-Set the endpoint speed to full, low, or high, respectively.
+.B "speed {low|full|high|super}
+Set the endpoint speed to full, low, high, or SuperSpeed, respectively.
 .TP
 .B hub
 Tell this driver that the endpoint corresponds to a hub device.
 .PD
 .PP
-Setup endpoints for hub devices also accept his request:
+Setup endpoints for hub devices also accept
 .TP
-.B "newdev {low|full|high} \fIport\fP
+.B "newdev {low|full|high|super} \fIport\fP
 Create a new setup endpoint to represent a new device.
 The first argument is the device speed.
 .I Port

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 20:27     ` qwx
  2021-08-24 21:02       ` Stuart Morrow
@ 2021-08-24 21:20       ` Humm
  2021-08-25  3:18         ` ori
  1 sibling, 1 reply; 18+ messages in thread
From: Humm @ 2021-08-24 21:20 UTC (permalink / raw)
  To: 9front

> I'm sure there are all of sorts of inconsistencies all over the 
> place, but expecting anyone to review and fix everything at once is 
> too much, it won't happen.

Oh yes, there are.  What comes to mind immediately is citation style 
and handling of options in SYNOPSIS (sometimes all are listed and 
sometimes there is just “[options]”), as well as just bad troff.  
There are some checks for bad stuff (see for example `mk punccheck` in 
/sys/man).

-- 
Humm

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 21:09         ` hiro
  2021-08-24 21:13           ` Stuart Morrow
@ 2021-08-24 21:33           ` Stuart Morrow
  1 sibling, 0 replies; 18+ messages in thread
From: Stuart Morrow @ 2021-08-24 21:33 UTC (permalink / raw)
  To: 9front

http://okturing.com/src/11943/body

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 21:02       ` Stuart Morrow
  2021-08-24 21:09         ` hiro
@ 2021-08-24 21:34         ` ori
  2021-08-24 23:42           ` Stuart Morrow
  2021-08-24 21:49         ` qwx
  2 siblings, 1 reply; 18+ messages in thread
From: ori @ 2021-08-24 21:34 UTC (permalink / raw)
  To: 9front

Quoth Stuart Morrow <morrow.stuart@gmail.com>:
> I was referring to the first post in the thread, with the 12K attachment.
> 
> Those diffs were at that time already a month old and ignored.
> 

Thanks for pinging.

So, lots of these look like some bike-shedding
for the sake of bike-shedding, without really
improving the quality of the documentation.

For example, is 'foreign-character-set' really
an improvement over 'foreign character-set'?
Is character-set an improvement over character set?

I think both changes are worse.

On the other hand, there are actual fixes
for omissions, like:

	-.B "newdev {low|full|high} \fIport\fP
	+.B "newdev {low|full|high|super} \fIport\fP

and styling issues like:

	-.I str ,
	+.IR str ,

If I could have this without the bikeshedding,
that would have been ideal.

Anyways, I think qwx is looking at this patch,
so I'll let them handle it.


^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 21:02       ` Stuart Morrow
  2021-08-24 21:09         ` hiro
  2021-08-24 21:34         ` ori
@ 2021-08-24 21:49         ` qwx
  2 siblings, 0 replies; 18+ messages in thread
From: qwx @ 2021-08-24 21:49 UTC (permalink / raw)
  To: 9front

I pushed part of your changes.  Some I rejected on my own
accord.  My earlier point stands, there are many more
instances of UTF and other shit that you didn't touch.
Moreover, if we do this for `UTF', why not `HTML' or `USB'
or whatever?

Thanks for bumping this, and any further changes are
welcome.

> Oh yes, there are.  What comes to mind immediately is citation style 
> and handling of options in SYNOPSIS (sometimes all are listed and 
> sometimes there is just “[options]”), as well as just bad troff.  
> There are some checks for bad stuff (see for example `mk punccheck` in 
> /sys/man).
> 
> -- 
> Humm

As always, patches welcome.

Thanks,

qwx

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 21:34         ` ori
@ 2021-08-24 23:42           ` Stuart Morrow
  2021-08-25  1:02             ` ori
  0 siblings, 1 reply; 18+ messages in thread
From: Stuart Morrow @ 2021-08-24 23:42 UTC (permalink / raw)
  To: 9front

> So, lots of these look like some bike-shedding
> for the sake of bike-shedding, without really
> improving the quality of the documentation.
>
> For example, is 'foreign-character-set' really
> an improvement over 'foreign character-set'?
> Is character-set an improvement over character set?

There's no way I can respond to this without it being further bikeshedding.

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 23:42           ` Stuart Morrow
@ 2021-08-25  1:02             ` ori
  2021-08-25 12:05               ` Stuart Morrow
  0 siblings, 1 reply; 18+ messages in thread
From: ori @ 2021-08-25  1:02 UTC (permalink / raw)
  To: 9front

Quoth Stuart Morrow <morrow.stuart@gmail.com>:
> > So, lots of these look like some bike-shedding
> > for the sake of bike-shedding, without really
> > improving the quality of the documentation.
> >
> > For example, is 'foreign-character-set' really
> > an improvement over 'foreign character-set'?
> > Is character-set an improvement over character set?
> 
> There's no way I can respond to this without it being further bikeshedding.

Sure.

It'd be helpful to separate incorrect formatting
from wording tweaks, if you're willing to go to
that effort.

And, thanks for sending in the fixes.


^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-24 21:20       ` Humm
@ 2021-08-25  3:18         ` ori
  2021-08-25  9:37           ` hiro
  0 siblings, 1 reply; 18+ messages in thread
From: ori @ 2021-08-25  3:18 UTC (permalink / raw)
  To: 9front

Quoth Humm <hummsmith42@gmail.com>:
> > I'm sure there are all of sorts of inconsistencies all over the 
> > place, but expecting anyone to review and fix everything at once is 
> > too much, it won't happen.
> 
> Oh yes, there are.  What comes to mind immediately is citation style 
> and handling of options in SYNOPSIS (sometimes all are listed and 
> sometimes there is just “[options]”), as well as just bad troff.  
> There are some checks for bad stuff (see for example `mk punccheck` in 
> /sys/man).

yes, for sure.

it helps me out if I get patches that focus on
one kind of issue: I have to keep less in mind
when reviewing, and format fixes are going to
get less debate than phrasing changes; I like it
when I can land fixes immediately.


^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-25  3:18         ` ori
@ 2021-08-25  9:37           ` hiro
  0 siblings, 0 replies; 18+ messages in thread
From: hiro @ 2021-08-25  9:37 UTC (permalink / raw)
  To: 9front

ori is probably right, but calling it all bikeshedding is also not
fair IMO. hopefully i missed the irony :)

there have been some changes that regard stylistic choices, where
neither option is more correct than the other,

to add further bikeshedding, some few changes are inconsistent.
e.g. SuperSpeed should be superspeed or super-speed IMO to fit into
the rest of the sentence.

On 8/25/21, ori@eigenstate.org <ori@eigenstate.org> wrote:
> Quoth Humm <hummsmith42@gmail.com>:
>> > I'm sure there are all of sorts of inconsistencies all over the
>> > place, but expecting anyone to review and fix everything at once is
>> > too much, it won't happen.
>>
>> Oh yes, there are.  What comes to mind immediately is citation style
>> and handling of options in SYNOPSIS (sometimes all are listed and
>> sometimes there is just “[options]”), as well as just bad troff.
>> There are some checks for bad stuff (see for example `mk punccheck` in
>> /sys/man).
>
> yes, for sure.
>
> it helps me out if I get patches that focus on
> one kind of issue: I have to keep less in mind
> when reviewing, and format fixes are going to
> get less debate than phrasing changes; I like it
> when I can land fixes immediately.
>
>

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-25  1:02             ` ori
@ 2021-08-25 12:05               ` Stuart Morrow
  2021-08-25 22:50                 ` ori
  0 siblings, 1 reply; 18+ messages in thread
From: Stuart Morrow @ 2021-08-25 12:05 UTC (permalink / raw)
  To: 9front

On 25/08/2021, ori@eigenstate.org <ori@eigenstate.org> wrote:
> It'd be helpful to separate incorrect formatting
> from wording tweaks, if you're willing to go to
> that effort.

You mean in the files that remain untouched after the last commit?
Those would be
2/ioproc
8/ndb
8/venti-backup
and in fact I only ever sent formatting fixes for them:

--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/2/ioproc
+++ /sys/man/2/ioproc
@@ -92,7 +92,7 @@
 .PP
 .I Closeioproc
 terminates the I/O proc and frees the associated
-.B Ioproc .
+.BR Ioproc .
 .PP
 .I Iocall
 is a primitive that may be used to implement
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/8/ndb
+++ /sys/man/8/ndb
@@ -764,7 +764,7 @@
 .PP
 .I Ndb/dnsgetip
 resolves and prints A and AAAA records without consulting
-.I ndb/dns .
+.IR ndb/dns .
 By default,
 .I ndb/dnsgetip
 queries A records first and then AAAA records. As with
--- //.git/fs/object/be36c092ac061a04065720e98e5849130487be7f/tree//sys/man/8/venti-backup
+++ /sys/man/8/venti-backup
@@ -66,7 +66,7 @@
 (default
 .BR 0 )
 in
-.I arenafile .
+.IR arenafile .
 This is useful for reading directly from
 the Venti arena partition:
 .IP

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-25 12:05               ` Stuart Morrow
@ 2021-08-25 22:50                 ` ori
  2021-08-26 10:02                   ` Stuart Morrow
  0 siblings, 1 reply; 18+ messages in thread
From: ori @ 2021-08-25 22:50 UTC (permalink / raw)
  To: 9front

Quoth Stuart Morrow <morrow.stuart@gmail.com>:
> On 25/08/2021, ori@eigenstate.org <ori@eigenstate.org> wrote:
> > It'd be helpful to separate incorrect formatting
> > from wording tweaks, if you're willing to go to
> > that effort.
> 
> You mean in the files that remain untouched after the last commit?
> Those would be

I'm not sure if I'm missing something, but these
changes appear to be in the last commit:

	cd /dist/plan9front \
		&& git/export ad26f82e44a5f59383edfde5f4c3727c225f4b0a \
		| grep (ioproc|ndb|venti-backup)


^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-25 22:50                 ` ori
@ 2021-08-26 10:02                   ` Stuart Morrow
  2021-08-26 14:26                     ` ori
  0 siblings, 1 reply; 18+ messages in thread
From: Stuart Morrow @ 2021-08-26 10:02 UTC (permalink / raw)
  To: 9front

On 25/08/2021, ori@eigenstate.org <ori@eigenstate.org> wrote:
>  ... these changes appear to be in the last commit:

Yeah, you're right. Not sure how I worked that out (either the website
or 9front-commits, but they're both right, just count the number of
'+++'s).

So for what files am I supposed to separate troff/informational
changes from grammar ones?

In any case your reason for wanting them separate is sound; a patch
should do one thing, preferably well.

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [9front] Re: man pages
  2021-08-26 10:02                   ` Stuart Morrow
@ 2021-08-26 14:26                     ` ori
  0 siblings, 0 replies; 18+ messages in thread
From: ori @ 2021-08-26 14:26 UTC (permalink / raw)
  To: 9front

Quoth Stuart Morrow <morrow.stuart@gmail.com>:
> On 25/08/2021, ori@eigenstate.org <ori@eigenstate.org> wrote:
> >  ... these changes appear to be in the last commit:
> 
> Yeah, you're right. Not sure how I worked that out (either the website
> or 9front-commits, but they're both right, just count the number of
> '+++'s).
> 
> So for what files am I supposed to separate troff/informational
> changes from grammar ones?
> 

future patches, if you find more issues and improvements.
I'm not asking you to rework anything that's been sent.


^ permalink raw reply	[flat|nested] 18+ messages in thread

end of thread, other threads:[~2021-08-26 14:48 UTC | newest]

Thread overview: 18+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <CABB-WO9mMVTigW9s96s88nPvA8fEijD6m-K_aR-=cMvDG363dQ@mail.gmail.com>
2021-08-14 16:56 ` [9front] Re: man pages Stuart Morrow
2021-08-24 17:21   ` Stuart Morrow
2021-08-24 20:27     ` qwx
2021-08-24 21:02       ` Stuart Morrow
2021-08-24 21:09         ` hiro
2021-08-24 21:13           ` Stuart Morrow
2021-08-24 21:33           ` Stuart Morrow
2021-08-24 21:34         ` ori
2021-08-24 23:42           ` Stuart Morrow
2021-08-25  1:02             ` ori
2021-08-25 12:05               ` Stuart Morrow
2021-08-25 22:50                 ` ori
2021-08-26 10:02                   ` Stuart Morrow
2021-08-26 14:26                     ` ori
2021-08-24 21:49         ` qwx
2021-08-24 21:20       ` Humm
2021-08-25  3:18         ` ori
2021-08-25  9:37           ` hiro

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).