NetBSD Problem Report #47205

From mm_lists@pulsar-zone.net  Sat Nov 17 05:23:12 2012
Return-Path: <mm_lists@pulsar-zone.net>
Received: from mail.netbsd.org (mail.netbsd.org [149.20.53.66])
	by www.NetBSD.org (Postfix) with ESMTP id 4B38963E854
	for <gnats-bugs@gnats.NetBSD.org>; Sat, 17 Nov 2012 05:23:12 +0000 (UTC)
Message-Id: <201211170358.qAH3wMCH019935@ginseng.pulsar-zone.net>
Date: Fri, 16 Nov 2012 22:58:21 -0500
From: Matthew Mondor <mm_lists@pulsar-zone.net>
To: gnats-bugs@gnats.NetBSD.org
Subject: expand.1 man page enhancements

>Number:         47205
>Category:       bin
>Synopsis:       expand.1 man page enhancements
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    pgoyette
>State:          closed
>Class:          change-request
>Submitter-Id:   net
>Arrival-Date:   Sat Nov 17 05:25:01 +0000 2012
>Closed-Date:    Tue May 31 11:24:24 +0000 2016
>Last-Modified:  Tue May 31 11:24:24 +0000 2016
>Originator:     Matthew Mondor
>Release:        -current, netbsd-6
>Organization:
>Environment:
System: NetBSD ninja.xisop 6.0_STABLE NetBSD 6.0_STABLE (GENERIC_MM) #0: Mon Nov 5 19:32:57 EST 2012 root@ninja.xisop:/usr/obj/sys/arch/amd64/compile/GENERIC_MM amd64
Architecture: x86_64
Machine: amd64
>Description:
	Someone on IRC (wolfpython) thought the documentation for -t
	was ambiguous, and when I checked I also did; he also thinks
	the new wording is clearer (feel free to review and suggest
	alternatives).
>How-To-Repeat:
>Fix:
	Suggested patch attached (against revision 1.12/current)
--MP_/JxIW_W+EJjeh4C_jxwgyYm_
Content-Type: text/plain
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename=expand-diff.txt

--- expand.1.orig	2012-11-16 22:49:45.000000000 -0500
+++ expand.1	2012-11-16 22:48:41.000000000 -0500
@@ -56,26 +56,27 @@
 (before sorting, looking at specific columns, etc.) that
 contain tabs.
 .Pp
-If a single
-.Ar tabstop
-argument is given, then tabs are set
-.Ar tabstop
-spaces apart instead of the default 8.
-If multiple tabstops are given then the tabs are set at those
-specific columns.
-.Pp
 .Nm unexpand
 puts tabs back into the data from the standard input or the named
 files and writes the result on the standard output.
 .Pp
-Option (with
-.Nm unexpand
-only):
+Options:
+.Bl -tag -width flag
+.It Fl t
+Unlike offsets in spaces, tapstops represent tabulator column
+positions.  The default
+.Ar tabstop
+width is 8, but can be changed using
+.Fl t
+with a single argument.  When multiple arguments are supplied, the
+multiple tabulator characters in a line will be expanded accordingly
+to the supplied column positions, respectively.
+.El
 .Bl -tag -width flag
 .It Fl a
-By default, only leading blanks and tabs
-are reconverted to maximal strings of tabs.
-If the
+.Nm ( unexpand
+only): By default, only leading blanks and tabs are reconverted to
+maximal strings of tabs.  If the
 .Fl a
 option is given, then tabs are inserted whenever they would compress the
 resultant file by replacing two or more characters.

--MP_/JxIW_W+EJjeh4C_jxwgyYm_--

>Release-Note:

>Audit-Trail:
From: Matthew Mondor <mm_lists@pulsar-zone.net>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: bin/47205: expand.1 man page enhancements
Date: Sat, 17 Nov 2012 01:26:08 -0500

 On Sat, 17 Nov 2012 05:25:01 +0000 (UTC)
 Matthew Mondor <mm_lists@pulsar-zone.net> wrote:

 > +Unlike offsets in spaces, tapstops represent tabulator column

 s/tapstops/tabstops/ :)

 -- 
 Matt

Responsible-Changed-From-To: bin-bug-people->pgoyette
Responsible-Changed-By: pgoyette@NetBSD.org
Responsible-Changed-When: Tue, 31 May 2016 07:39:00 +0000
Responsible-Changed-Why:
I'll take this one on.


State-Changed-From-To: open->analyzed
State-Changed-By: pgoyette@NetBSD.org
State-Changed-When: Tue, 31 May 2016 07:39:00 +0000
State-Changed-Why:
Well, I looked at the proposed wording changes, and I find the suggestion
worse than the current/original.  I expecially don't like the use of the
word "tabulator" (and I can't remember seeing any other man page refer to
a "tab character \t" as a "tabulator).  So unless someone comes up with
some _really_ better description for the -t option, I'm going to just close
the PR without making any changes.


State-Changed-From-To: analyzed->feedback
State-Changed-By: pgoyette@NetBSD.org
State-Changed-When: Tue, 31 May 2016 07:40:03 +0000
State-Changed-Why:
Since I'm waiting for feedback from the originator (or from the peanut
gallery) I guess "feedback" is a better state than "analyzed".


From: Matthew Mondor <mm_lists@pulsar-zone.net>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: bin/47205 (expand.1 man page enhancements)
Date: Tue, 31 May 2016 05:53:54 -0400

 On Tue, 31 May 2016 07:40:04 +0000 (UTC)
 pgoyette@NetBSD.org wrote:

 > Synopsis: expand.1 man page enhancements
 > 
 > State-Changed-From-To: analyzed->feedback
 > State-Changed-By: pgoyette@NetBSD.org
 > State-Changed-When: Tue, 31 May 2016 07:40:03 +0000
 > State-Changed-Why:
 > Since I'm waiting for feedback from the originator (or from the peanut
 > gallery) I guess "feedback" is a better state than "analyzed".

 Then please close this one.  I have no time to currently work on a
 better solution and would like to avoid receiving the future "Problem
 Report waiting feedback" multiple messages.

 I think that I agree that the wording is less than adequate (the
 original, as well with my modifications).  We also cannot really
 transform the man page into a tutorial.

 The worse part seems to be "maximal strings of tabs" and my changes did
 not even address that one.

 Thanks,

 -- 
 Matt

State-Changed-From-To: feedback->closed
State-Changed-By: pgoyette@NetBSD.org
State-Changed-When: Tue, 31 May 2016 11:24:24 +0000
State-Changed-Why:
Nothing to do here, at least not for now.  Maybe reopen later if a
better rewrie of the man-page comes along.


>Unformatted:
 --MP_/JxIW_W+EJjeh4C_jxwgyYm_
 Content-Type: text/plain; charset=US-ASCII
 Content-Transfer-Encoding: 7bit
 Content-Disposition: inline

Home	PR Database Search