tech@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Ingo Schwarze <schwarze@usta.de>
To: Baptiste Daroussin <bapt@FreeBSD.org>
Cc: tech@mandoc.bsd.lv
Subject: Re: Add few posix references
Date: Tue, 12 Dec 2017 19:28:17 +0100	[thread overview]
Message-ID: <20171212182817.GA817@athene.usta.de> (raw)
In-Reply-To: <20171206101513.pxqilsyikp6yoxxa@ivaldir.net>

Hi Baptiste,

On Wed, Dec 06, 2017 at 11:11:43AM +0100, Baptiste Daroussin wrote:

> There was 2 extra edition of POSIX 2008: one in 2013 and one in 2016

I strongly disagree.  These are not new editions.  They are merely
technical corrigenda that almost exclusively fix trivial typos and
subtle wording details that are beyond the scope of manual pages
in the first place.  We have found practically nothing related to
them that is worth mentioning in any manual page.

> Some manpages refers to them (for example freebsd's rm(1)),

The STANDARDS section in FreeBSD rm(1) is totally broken.
If you really want to reference TC1, then you have to say

  .St -p1003.1-2008

and then specifically explain in which respect TC1 makes a difference,
because that would be such a rare exception that merely referring
to TC1 without giving any details does not help the user at all.

> here is a patch to add them

No.  Please remove these from your tree: the macros, their
documentation, and all use cases.  Even if you find a handful of
cases where explaining something related to TC1 or TC2 is useful,
just talk about TC1 and TC2 in plain English.  No macros are needed
for something that appears only a handful of times in a huge tree.

It is among the important design goals of mandoc to prevent further
proliferation of low-utility syntax.

Yours,
  Ingo


> Index: mdoc.7
> ===================================================================
> RCS file: /cvs/mandoc/mdoc.7,v
> retrieving revision 1.270
> diff -u -r1.270 mdoc.7
> --- mdoc.7	23 Oct 2017 13:54:41 -0000	1.270
> +++ mdoc.7	6 Dec 2017 10:14:20 -0000
> @@ -2599,6 +2599,16 @@
>  .br
>  This standard is also called
>  X/Open Portability Guide version 7.
> +.Pp
> +.It \-p1003.1-2013
> +.St -p1003.1-2013
> +The 2013 edition incorporates Technical Corrigendum 1.
> +.Pp
> +.It \-p1003.1-2016
> +.St -p1003.1-2016
> +.br
> +The 2016 edition incorporates Technical Corrigendum 1 and
> +Technical Corrigendum 2.
>  .El
>  .It Other standards
>  .Pp
> Index: st.in
> ===================================================================
> RCS file: /cvs/mandoc/st.in,v
> retrieving revision 1.29
> diff -u -r1.29 st.in
> --- st.in	24 Jun 2017 13:49:29 -0000	1.29
> +++ st.in	6 Dec 2017 10:14:20 -0000
> @@ -34,6 +34,8 @@
>  LINE("-p1003.1-2001",	"IEEE Std 1003.1-2001 (\\(LqPOSIX.1\\(Rq)")
>  LINE("-p1003.1-2004",	"IEEE Std 1003.1-2004 (\\(LqPOSIX.1\\(Rq)")
>  LINE("-p1003.1-2008",	"IEEE Std 1003.1-2008 (\\(LqPOSIX.1\\(Rq)")
> +LINE("-p1003.1-2013",	"IEEE Std 1003.1-2008, 2013 Edition (\\(LqPOSIX.1\\(Rq)")
> +LINE("-p1003.1-2016",	"IEEE Std 1003.1-2008, 2016 Edition (\\(LqPOSIX.1\\(Rq)")
>  LINE("-p1003.1",	"IEEE Std 1003.1 (\\(LqPOSIX.1\\(Rq)")
>  LINE("-p1003.1b",	"IEEE Std 1003.1b (\\(LqPOSIX.1b\\(Rq)")
>  LINE("-p1003.1b-93",	"IEEE Std 1003.1b-1993 (\\(LqPOSIX.1b\\(Rq)")
--
 To unsubscribe send an email to tech+unsubscribe@mandoc.bsd.lv

      parent reply	other threads:[~2017-12-12 18:28 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-12-06 10:11 Baptiste Daroussin
2017-12-06 10:15 ` Baptiste Daroussin
2017-12-05 21:39   ` Steffen Nurpmeso
2017-12-12 18:28   ` Ingo Schwarze [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20171212182817.GA817@athene.usta.de \
    --to=schwarze@usta.de \
    --cc=bapt@FreeBSD.org \
    --cc=tech@mandoc.bsd.lv \
    --subject='Re: Add few posix references' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

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).