Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 5 Apr 2018 20:00:56 -0700
From:      Steve Kargl <sgk@troutmask.apl.washington.edu>
To:        Benjamin Kaduk <bjk@freebsd.org>
Cc:        freebsd-current <freebsd-current@freebsd.org>
Subject:   Re: clang manual page?
Message-ID:  <20180406030056.GA44536@troutmask.apl.washington.edu>
In-Reply-To: <20180406011149.GF80088@mit.edu>
References:  <20180405223852.GA43120@troutmask.apl.washington.edu> <CAG6CVpUpj7B6ujUSCUkznCBKSGKcuM2czZ=VBgKK%2Bkm5wFwfmg@mail.gmail.com> <20180406001514.GA43793@troutmask.apl.washington.edu> <CAG6CVpWPWCut9fNaPUyQLx9%2B1FiSXgLw6mJXoj6%2BHOmfXWVE9w@mail.gmail.com> <20180406005624.GB43998@troutmask.apl.washington.edu> <20180406011149.GF80088@mit.edu>

next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Apr 05, 2018 at 08:11:50PM -0500, Benjamin Kaduk wrote:
> On Thu, Apr 05, 2018 at 05:56:24PM -0700, Steve Kargl wrote:
> > I never said that you said it was in base.  I'm noting that
> > referring a user to a non-existent manual page is of little
> > help.  In fact, your 7 word response is an affirmation that
> > the tools supplied in base should be properly documented.
> 
> It would probably be more useful to file explicit bug reports
> (or even write a patch) about missing or poor documentation, than
> to proffer passive-aggressive inquiries on public mailing lists
> that merely suggest but do not explicitly state that the
> documentation is deficient.
> 

There is nothing passive nor aggressive in asking about how
to use the tools supplied in base because its accompanying
documentation is substantially lacking in quality.  

It should be the responsibility of the individual (or individuals)
who import new software into base to ensure that it has proper
documentation.  Of course, the assumption is that this individual
has (or these individuals have) a familiarity with the software,
which should facilitate writing said documentation.  This started
8 year 10 months ago when clang pre-2.8 was committed without a
manpage.  The initial version of clang.1 appeared 7 year 6 months
ago.  FreeBSD is now at clang 6.0.0.  I fully anticipate that the
next import of clang will again have poor documentation.

To preempt a retort about "stop complaining and contribute a fix",
I'll note that all of my previous contributions that are in base have
been accompanied by documentation.

-- 
Steve



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20180406030056.GA44536>